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         - name: data-center-code
 145           in: query
 146           description: Data center code which can be an alternate way to identify a complex
 147           required: false
 148           type: string
 149         - name: complex-name
 150           in: query
 151           description: Gamma complex name for LCP instance.
 152           required: false
 153           type: string
 154         - name: identity-url
 155           in: query
 156           description: URL of the keystone identity service
 157           required: false
 158           type: string
 159     put:
 160       tags:
 161         - CloudInfrastructure
 162       summary: create or update an existing ctag-pool
 163       description: |
 164         Create or update an existing ctag-pool.
 165         #
 166         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
 167       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 168       consumes:
 169         - application/json
 170         - application/xml
 171       produces:
 172         - application/json
 173         - application/xml
 174       responses:
 175         "default":
 176           description: Response codes found in [response codes](https://wiki.onap.org/).
 177       parameters:
 178         - name: physical-location-id
 179           in: path
 180           description: Unique identifier for physical location, e.g., CLLI
 181           required: true
 182           type: string
 183           example: __PHYSICAL-LOCATION-ID__
 184         - name: target-pe
 185           in: path
 186           description: The Target provider edge router
 187           required: true
 188           type: string
 189           example: __TARGET-PE__
 190         - name: availability-zone-name
 191           in: path
 192           description: Name of the availability zone
 193           required: true
 194           type: string
 195           example: __AVAILABILITY-ZONE-NAME__
 196         - name: body
 197           in: body
 198           description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
 199           required: true
 200           schema:
 201             $ref: "#/definitions/ctag-pool"
 202     patch:
 203       tags:
 204         - CloudInfrastructure
 205       summary: update an existing ctag-pool
 206       description: |
 207         Update an existing ctag-pool
 208         #
 209         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 210         The PUT operation will entirely replace an existing object.
 211         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.
 212         #
 213         Other differences between PUT and PATCH are:
 214         #
 215         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 216         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 217         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 218       operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 219       consumes:
 220         - application/json
 221         - application/xml
 222       produces:
 223         - application/json
 224         - application/xml
 225       responses:
 226         "default":
 227           description: Response codes found in [response codes](https://wiki.onap.org/).
 228       parameters:
 229         - name: physical-location-id
 230           in: path
 231           description: Unique identifier for physical location, e.g., CLLI
 232           required: true
 233           type: string
 234           example: __PHYSICAL-LOCATION-ID__
 235         - name: target-pe
 236           in: path
 237           description: The Target provider edge router
 238           required: true
 239           type: string
 240           example: __TARGET-PE__
 241         - name: availability-zone-name
 242           in: path
 243           description: Name of the availability zone
 244           required: true
 245           type: string
 246           example: __AVAILABILITY-ZONE-NAME__
 247         - name: body
 248           in: body
 249           description: ctag-pool object that needs to be created or updated.
 250           required: true
 251           schema:
 252             $ref: "#/patchDefinitions/ctag-pool"
 253     delete:
 254       tags:
 255         - CloudInfrastructure
 256       summary: delete an existing ctag-pool
 257       description: delete an existing ctag-pool
 258       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 259       consumes:
 260         - application/json
 261         - application/xml
 262       produces:
 263         - application/json
 264         - application/xml
 265       responses:
 266         "default":
 267           description: Response codes found in [response codes](https://wiki.onap.org/).
 268       parameters:
 269         - name: physical-location-id
 270           in: path
 271           description: Unique identifier for physical location, e.g., CLLI
 272           required: true
 273           type: string
 274           example: __PHYSICAL-LOCATION-ID__
 275         - name: target-pe
 276           in: path
 277           description: The Target provider edge router
 278           required: true
 279           type: string
 280           example: __TARGET-PE__
 281         - name: availability-zone-name
 282           in: path
 283           description: Name of the availability zone
 284           required: true
 285           type: string
 286           example: __AVAILABILITY-ZONE-NAME__
 287         - name: resource-version
 288           in: query
 289           description: resource-version for concurrency
 290           required: true
 291           type: string
 292   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
 293     get:
 294       tags:
 295         - CloudInfrastructure
 296       summary: returns ctag-pools
 297       description: returns ctag-pools
 298       operationId: getCloudInfrastructureComplexesComplexCtagPools
 299       produces:
 300         - application/json
 301         - application/xml
 302       responses:
 303         "200":
 304           description: successful operation
 305           schema:
 306               $ref: "#/getDefinitions/ctag-pools"
 307         "default":
 308           description: Response codes found in [response codes](https://wiki.onap.org/).
 309       parameters:
 310         - name: physical-location-id
 311           in: path
 312           description: Unique identifier for physical location, e.g., CLLI
 313           required: true
 314           type: string
 315           example: __PHYSICAL-LOCATION-ID__
 316         - name: data-center-code
 317           in: query
 318           description: Data center code which can be an alternate way to identify a complex
 319           required: false
 320           type: string
 321         - name: complex-name
 322           in: query
 323           description: Gamma complex name for LCP instance.
 324           required: false
 325           type: string
 326         - name: identity-url
 327           in: query
 328           description: URL of the keystone identity service
 329           required: false
 330           type: string
 331   /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
 332     put:
 333       tags:
 334         - CloudInfrastructure
 335       summary: see node definition for valid relationships
 336       operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
 337       consumes:
 338         - application/json
 339         - application/xml
 340       produces:
 341         - application/json
 342         - application/xml
 343       responses:
 344         "default":
 345           description: Response codes found in [response codes](https://wiki.onap.org/).
 346       parameters:
 347         - name: physical-location-id
 348           in: path
 349           description: Unique identifier for physical location, e.g., CLLI
 350           required: true
 351           type: string
 352           example: __PHYSICAL-LOCATION-ID__
 353         - name: body
 354           in: body
 355           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)
 356           required: true
 357           schema:
 358             $ref: "#/definitions/relationship"
 359     delete:
 360       tags:
 361         - CloudInfrastructure
 362       summary: delete an existing relationship
 363       description: delete an existing relationship
 364       operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
 365       consumes:
 366         - application/json
 367         - application/xml
 368       produces:
 369         - application/json
 370         - application/xml
 371       responses:
 372         "default":
 373           description: Response codes found in [response codes](https://wiki.onap.org/).
 374       parameters:
 375         - name: physical-location-id
 376           in: path
 377           description: Unique identifier for physical location, e.g., CLLI
 378           required: true
 379           type: string
 380           example: __PHYSICAL-LOCATION-ID__
 381   /cloud-infrastructure/complexes/complex/{physical-location-id}:
 382     get:
 383       tags:
 384         - CloudInfrastructure
 385       summary: returns complex
 386       description: returns complex
 387       operationId: getCloudInfrastructureComplexesComplex
 388       produces:
 389         - application/json
 390         - application/xml
 391       responses:
 392         "200":
 393           description: successful operation
 394           schema:
 395               $ref: "#/getDefinitions/complex"
 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: data-center-code
 406           in: query
 407           description: Data center code which can be an alternate way to identify a complex
 408           required: false
 409           type: string
 410         - name: complex-name
 411           in: query
 412           description: Gamma complex name for LCP instance.
 413           required: false
 414           type: string
 415         - name: identity-url
 416           in: query
 417           description: URL of the keystone identity service
 418           required: false
 419           type: string
 420     put:
 421       tags:
 422         - CloudInfrastructure
 423       summary: create or update an existing complex
 424       description: |
 425         Create or update an existing complex.
 426         #
 427         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
 428       operationId: createOrUpdateCloudInfrastructureComplexesComplex
 429       consumes:
 430         - application/json
 431         - application/xml
 432       produces:
 433         - application/json
 434         - application/xml
 435       responses:
 436         "default":
 437           description: Response codes found in [response codes](https://wiki.onap.org/).
 438       parameters:
 439         - name: physical-location-id
 440           in: path
 441           description: Unique identifier for physical location, e.g., CLLI
 442           required: true
 443           type: string
 444           example: __PHYSICAL-LOCATION-ID__
 445         - name: body
 446           in: body
 447           description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureComplexesComplex.json)
 448           required: true
 449           schema:
 450             $ref: "#/definitions/complex"
 451     patch:
 452       tags:
 453         - CloudInfrastructure
 454       summary: update an existing complex
 455       description: |
 456         Update an existing complex
 457         #
 458         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 459         The PUT operation will entirely replace an existing object.
 460         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.
 461         #
 462         Other differences between PUT and PATCH are:
 463         #
 464         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 465         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 466         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 467       operationId: UpdateCloudInfrastructureComplexesComplex
 468       consumes:
 469         - application/json
 470         - application/xml
 471       produces:
 472         - application/json
 473         - application/xml
 474       responses:
 475         "default":
 476           description: Response codes found in [response codes](https://wiki.onap.org/).
 477       parameters:
 478         - name: physical-location-id
 479           in: path
 480           description: Unique identifier for physical location, e.g., CLLI
 481           required: true
 482           type: string
 483           example: __PHYSICAL-LOCATION-ID__
 484         - name: body
 485           in: body
 486           description: complex object that needs to be created or updated.
 487           required: true
 488           schema:
 489             $ref: "#/patchDefinitions/complex"
 490     delete:
 491       tags:
 492         - CloudInfrastructure
 493       summary: delete an existing complex
 494       description: delete an existing complex
 495       operationId: deleteCloudInfrastructureComplexesComplex
 496       consumes:
 497         - application/json
 498         - application/xml
 499       produces:
 500         - application/json
 501         - application/xml
 502       responses:
 503         "default":
 504           description: Response codes found in [response codes](https://wiki.onap.org/).
 505       parameters:
 506         - name: physical-location-id
 507           in: path
 508           description: Unique identifier for physical location, e.g., CLLI
 509           required: true
 510           type: string
 511           example: __PHYSICAL-LOCATION-ID__
 512         - name: resource-version
 513           in: query
 514           description: resource-version for concurrency
 515           required: true
 516           type: string
 517   /cloud-infrastructure/complexes:
 518     get:
 519       tags:
 520         - CloudInfrastructure
 521       summary: returns complexes
 522       description: returns complexes
 523       operationId: getCloudInfrastructureComplexes
 524       produces:
 525         - application/json
 526         - application/xml
 527       responses:
 528         "200":
 529           description: successful operation
 530           schema:
 531               $ref: "#/getDefinitions/complexes"
 532         "default":
 533           description: Response codes found in [response codes](https://wiki.onap.org/).
 534   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
 535     put:
 536       tags:
 537         - CloudInfrastructure
 538       summary: see node definition for valid relationships
 539       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 540       consumes:
 541         - application/json
 542         - application/xml
 543       produces:
 544         - application/json
 545         - application/xml
 546       responses:
 547         "default":
 548           description: Response codes found in [response codes](https://wiki.onap.org/).
 549       parameters:
 550         - name: cloud-owner
 551           in: path
 552           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 553           required: true
 554           type: string
 555           example: __CLOUD-OWNER__
 556         - name: cloud-region-id
 557           in: path
 558           description: Identifier used by the vendor for the region. Second part of composite key
 559           required: true
 560           type: string
 561           example: __CLOUD-REGION-ID__
 562         - name: volume-group-id
 563           in: path
 564           description: Unique ID of volume-group.
 565           required: true
 566           type: string
 567           example: __VOLUME-GROUP-ID__
 568         - name: body
 569           in: body
 570           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 571           required: true
 572           schema:
 573             $ref: "#/definitions/relationship"
 574     delete:
 575       tags:
 576         - CloudInfrastructure
 577       summary: delete an existing relationship
 578       description: delete an existing relationship
 579       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 580       consumes:
 581         - application/json
 582         - application/xml
 583       produces:
 584         - application/json
 585         - application/xml
 586       responses:
 587         "default":
 588           description: Response codes found in [response codes](https://wiki.onap.org/).
 589       parameters:
 590         - name: cloud-owner
 591           in: path
 592           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 593           required: true
 594           type: string
 595           example: __CLOUD-OWNER__
 596         - name: cloud-region-id
 597           in: path
 598           description: Identifier used by the vendor for the region. Second part of composite key
 599           required: true
 600           type: string
 601           example: __CLOUD-REGION-ID__
 602         - name: volume-group-id
 603           in: path
 604           description: Unique ID of volume-group.
 605           required: true
 606           type: string
 607           example: __VOLUME-GROUP-ID__
 608   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
 609     get:
 610       tags:
 611         - CloudInfrastructure
 612       summary: returns volume-group
 613       description: returns volume-group
 614       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 615       produces:
 616         - application/json
 617         - application/xml
 618       responses:
 619         "200":
 620           description: successful operation
 621           schema:
 622               $ref: "#/getDefinitions/volume-group"
 623         "default":
 624           description: Response codes found in [response codes](https://wiki.onap.org/).
 625       parameters:
 626         - name: cloud-owner
 627           in: path
 628           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 629           required: true
 630           type: string
 631           example: __CLOUD-OWNER__
 632         - name: cloud-region-id
 633           in: path
 634           description: Identifier used by the vendor for the region. Second part of composite key
 635           required: true
 636           type: string
 637           example: __CLOUD-REGION-ID__
 638         - name: volume-group-id
 639           in: path
 640           description: Unique ID of volume-group.
 641           required: true
 642           type: string
 643           example: __VOLUME-GROUP-ID__
 644         - name: cloud-type
 645           in: query
 646           description: Type of the cloud (e.g., openstack)
 647           required: false
 648           type: string
 649         - name: owner-defined-type
 650           in: query
 651           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 652           required: false
 653           type: string
 654         - name: volume-group-name
 655           in: query
 656           description: Name of the volume group.
 657           required: false
 658           type: string
 659         - name: heat-stack-id
 660           in: query
 661           description: Heat stack id corresponding to this volume-group
 662           required: false
 663           type: string
 664         - name: vnf-type
 665           in: query
 666           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.
 667           required: false
 668           type: string
 669     put:
 670       tags:
 671         - CloudInfrastructure
 672       summary: create or update an existing volume-group
 673       description: |
 674         Create or update an existing volume-group.
 675         #
 676         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
 677       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 678       consumes:
 679         - application/json
 680         - application/xml
 681       produces:
 682         - application/json
 683         - application/xml
 684       responses:
 685         "default":
 686           description: Response codes found in [response codes](https://wiki.onap.org/).
 687       parameters:
 688         - name: cloud-owner
 689           in: path
 690           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 691           required: true
 692           type: string
 693           example: __CLOUD-OWNER__
 694         - name: cloud-region-id
 695           in: path
 696           description: Identifier used by the vendor for the region. Second part of composite key
 697           required: true
 698           type: string
 699           example: __CLOUD-REGION-ID__
 700         - name: volume-group-id
 701           in: path
 702           description: Unique ID of volume-group.
 703           required: true
 704           type: string
 705           example: __VOLUME-GROUP-ID__
 706         - name: body
 707           in: body
 708           description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 709           required: true
 710           schema:
 711             $ref: "#/definitions/volume-group"
 712     patch:
 713       tags:
 714         - CloudInfrastructure
 715       summary: update an existing volume-group
 716       description: |
 717         Update an existing volume-group
 718         #
 719         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 720         The PUT operation will entirely replace an existing object.
 721         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.
 722         #
 723         Other differences between PUT and PATCH are:
 724         #
 725         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 726         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 727         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 728       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 729       consumes:
 730         - application/json
 731         - application/xml
 732       produces:
 733         - application/json
 734         - application/xml
 735       responses:
 736         "default":
 737           description: Response codes found in [response codes](https://wiki.onap.org/).
 738       parameters:
 739         - name: cloud-owner
 740           in: path
 741           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 742           required: true
 743           type: string
 744           example: __CLOUD-OWNER__
 745         - name: cloud-region-id
 746           in: path
 747           description: Identifier used by the vendor for the region. Second part of composite key
 748           required: true
 749           type: string
 750           example: __CLOUD-REGION-ID__
 751         - name: volume-group-id
 752           in: path
 753           description: Unique ID of volume-group.
 754           required: true
 755           type: string
 756           example: __VOLUME-GROUP-ID__
 757         - name: body
 758           in: body
 759           description: volume-group object that needs to be created or updated.
 760           required: true
 761           schema:
 762             $ref: "#/patchDefinitions/volume-group"
 763     delete:
 764       tags:
 765         - CloudInfrastructure
 766       summary: delete an existing volume-group
 767       description: delete an existing volume-group
 768       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 769       consumes:
 770         - application/json
 771         - application/xml
 772       produces:
 773         - application/json
 774         - application/xml
 775       responses:
 776         "default":
 777           description: Response codes found in [response codes](https://wiki.onap.org/).
 778       parameters:
 779         - name: cloud-owner
 780           in: path
 781           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 782           required: true
 783           type: string
 784           example: __CLOUD-OWNER__
 785         - name: cloud-region-id
 786           in: path
 787           description: Identifier used by the vendor for the region. Second part of composite key
 788           required: true
 789           type: string
 790           example: __CLOUD-REGION-ID__
 791         - name: volume-group-id
 792           in: path
 793           description: Unique ID of volume-group.
 794           required: true
 795           type: string
 796           example: __VOLUME-GROUP-ID__
 797         - name: resource-version
 798           in: query
 799           description: resource-version for concurrency
 800           required: true
 801           type: string
 802   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
 803     get:
 804       tags:
 805         - CloudInfrastructure
 806       summary: returns volume-groups
 807       description: returns volume-groups
 808       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
 809       produces:
 810         - application/json
 811         - application/xml
 812       responses:
 813         "200":
 814           description: successful operation
 815           schema:
 816               $ref: "#/getDefinitions/volume-groups"
 817         "default":
 818           description: Response codes found in [response codes](https://wiki.onap.org/).
 819       parameters:
 820         - name: cloud-owner
 821           in: path
 822           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 823           required: true
 824           type: string
 825           example: __CLOUD-OWNER__
 826         - name: cloud-region-id
 827           in: path
 828           description: Identifier used by the vendor for the region. Second part of composite key
 829           required: true
 830           type: string
 831           example: __CLOUD-REGION-ID__
 832         - name: cloud-type
 833           in: query
 834           description: Type of the cloud (e.g., openstack)
 835           required: false
 836           type: string
 837         - name: owner-defined-type
 838           in: query
 839           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 840           required: false
 841           type: string
 842   /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:
 843     put:
 844       tags:
 845         - CloudInfrastructure
 846       summary: see node definition for valid relationships
 847       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 848       consumes:
 849         - application/json
 850         - application/xml
 851       produces:
 852         - application/json
 853         - application/xml
 854       responses:
 855         "default":
 856           description: Response codes found in [response codes](https://wiki.onap.org/).
 857       parameters:
 858         - name: cloud-owner
 859           in: path
 860           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 861           required: true
 862           type: string
 863           example: __CLOUD-OWNER__
 864         - name: cloud-region-id
 865           in: path
 866           description: Identifier used by the vendor for the region. Second part of composite key
 867           required: true
 868           type: string
 869           example: __CLOUD-REGION-ID__
 870         - name: tenant-id
 871           in: path
 872           description: Unique id relative to the cloud-region.
 873           required: true
 874           type: string
 875           example: __TENANT-ID__
 876         - name: vserver-id
 877           in: path
 878           description: Unique identifier for this vserver relative to its tenant
 879           required: true
 880           type: string
 881           example: __VSERVER-ID__
 882         - name: volume-id
 883           in: path
 884           description: Unique ID of block storage volume relative to the vserver.
 885           required: true
 886           type: string
 887           example: __VOLUME-ID__
 888         - name: body
 889           in: body
 890           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
 891           required: true
 892           schema:
 893             $ref: "#/definitions/relationship"
 894     delete:
 895       tags:
 896         - CloudInfrastructure
 897       summary: delete an existing relationship
 898       description: delete an existing relationship
 899       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 900       consumes:
 901         - application/json
 902         - application/xml
 903       produces:
 904         - application/json
 905         - application/xml
 906       responses:
 907         "default":
 908           description: Response codes found in [response codes](https://wiki.onap.org/).
 909       parameters:
 910         - name: cloud-owner
 911           in: path
 912           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 913           required: true
 914           type: string
 915           example: __CLOUD-OWNER__
 916         - name: cloud-region-id
 917           in: path
 918           description: Identifier used by the vendor for the region. Second part of composite key
 919           required: true
 920           type: string
 921           example: __CLOUD-REGION-ID__
 922         - name: tenant-id
 923           in: path
 924           description: Unique id relative to the cloud-region.
 925           required: true
 926           type: string
 927           example: __TENANT-ID__
 928         - name: vserver-id
 929           in: path
 930           description: Unique identifier for this vserver relative to its tenant
 931           required: true
 932           type: string
 933           example: __VSERVER-ID__
 934         - name: volume-id
 935           in: path
 936           description: Unique ID of block storage volume relative to the vserver.
 937           required: true
 938           type: string
 939           example: __VOLUME-ID__
 940   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
 941     get:
 942       tags:
 943         - CloudInfrastructure
 944       summary: returns volume
 945       description: returns volume
 946       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 947       produces:
 948         - application/json
 949         - application/xml
 950       responses:
 951         "200":
 952           description: successful operation
 953           schema:
 954               $ref: "#/getDefinitions/volume"
 955         "default":
 956           description: Response codes found in [response codes](https://wiki.onap.org/).
 957       parameters:
 958         - name: cloud-owner
 959           in: path
 960           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 961           required: true
 962           type: string
 963           example: __CLOUD-OWNER__
 964         - name: cloud-region-id
 965           in: path
 966           description: Identifier used by the vendor for the region. Second part of composite key
 967           required: true
 968           type: string
 969           example: __CLOUD-REGION-ID__
 970         - name: tenant-id
 971           in: path
 972           description: Unique id relative to the cloud-region.
 973           required: true
 974           type: string
 975           example: __TENANT-ID__
 976         - name: vserver-id
 977           in: path
 978           description: Unique identifier for this vserver relative to its tenant
 979           required: true
 980           type: string
 981           example: __VSERVER-ID__
 982         - name: volume-id
 983           in: path
 984           description: Unique ID of block storage volume relative to the vserver.
 985           required: true
 986           type: string
 987           example: __VOLUME-ID__
 988         - name: cloud-type
 989           in: query
 990           description: Type of the cloud (e.g., openstack)
 991           required: false
 992           type: string
 993         - name: owner-defined-type
 994           in: query
 995           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 996           required: false
 997           type: string
 998         - name: tenant-name
 999           in: query
1000           description: Readable name of tenant
1001           required: false
1002           type: string
1003         - name: tenant-context
1004           in: query
1005           description: This field will store the tenant context.
1006           required: false
1007           type: string
1008         - name: vserver-name
1009           in: query
1010           description: Name of vserver
1011           required: false
1012           type: string
1013         - name: vserver-name2
1014           in: query
1015           description: Alternative name of vserver
1016           required: false
1017           type: string
1018         - name: prov-status
1019           in: query
1020           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1021           required: false
1022           type: string
1023         - name: in-maint
1024           in: query
1025           required: false
1026           type: boolean
1027         - name: is-closed-loop-disabled
1028           in: query
1029           required: false
1030           type: boolean
1031     put:
1032       tags:
1033         - CloudInfrastructure
1034       summary: create or update an existing volume
1035       description: |
1036         Create or update an existing volume.
1037         #
1038         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
1039       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1040       consumes:
1041         - application/json
1042         - application/xml
1043       produces:
1044         - application/json
1045         - application/xml
1046       responses:
1047         "default":
1048           description: Response codes found in [response codes](https://wiki.onap.org/).
1049       parameters:
1050         - name: cloud-owner
1051           in: path
1052           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1053           required: true
1054           type: string
1055           example: __CLOUD-OWNER__
1056         - name: cloud-region-id
1057           in: path
1058           description: Identifier used by the vendor for the region. Second part of composite key
1059           required: true
1060           type: string
1061           example: __CLOUD-REGION-ID__
1062         - name: tenant-id
1063           in: path
1064           description: Unique id relative to the cloud-region.
1065           required: true
1066           type: string
1067           example: __TENANT-ID__
1068         - name: vserver-id
1069           in: path
1070           description: Unique identifier for this vserver relative to its tenant
1071           required: true
1072           type: string
1073           example: __VSERVER-ID__
1074         - name: volume-id
1075           in: path
1076           description: Unique ID of block storage volume relative to the vserver.
1077           required: true
1078           type: string
1079           example: __VOLUME-ID__
1080         - name: body
1081           in: body
1082           description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1083           required: true
1084           schema:
1085             $ref: "#/definitions/volume"
1086     patch:
1087       tags:
1088         - CloudInfrastructure
1089       summary: update an existing volume
1090       description: |
1091         Update an existing volume
1092         #
1093         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1094         The PUT operation will entirely replace an existing object.
1095         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.
1096         #
1097         Other differences between PUT and PATCH are:
1098         #
1099         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1100         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1101         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1102       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1103       consumes:
1104         - application/json
1105         - application/xml
1106       produces:
1107         - application/json
1108         - application/xml
1109       responses:
1110         "default":
1111           description: Response codes found in [response codes](https://wiki.onap.org/).
1112       parameters:
1113         - name: cloud-owner
1114           in: path
1115           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1116           required: true
1117           type: string
1118           example: __CLOUD-OWNER__
1119         - name: cloud-region-id
1120           in: path
1121           description: Identifier used by the vendor for the region. Second part of composite key
1122           required: true
1123           type: string
1124           example: __CLOUD-REGION-ID__
1125         - name: tenant-id
1126           in: path
1127           description: Unique id relative to the cloud-region.
1128           required: true
1129           type: string
1130           example: __TENANT-ID__
1131         - name: vserver-id
1132           in: path
1133           description: Unique identifier for this vserver relative to its tenant
1134           required: true
1135           type: string
1136           example: __VSERVER-ID__
1137         - name: volume-id
1138           in: path
1139           description: Unique ID of block storage volume relative to the vserver.
1140           required: true
1141           type: string
1142           example: __VOLUME-ID__
1143         - name: body
1144           in: body
1145           description: volume object that needs to be created or updated.
1146           required: true
1147           schema:
1148             $ref: "#/patchDefinitions/volume"
1149     delete:
1150       tags:
1151         - CloudInfrastructure
1152       summary: delete an existing volume
1153       description: delete an existing volume
1154       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1155       consumes:
1156         - application/json
1157         - application/xml
1158       produces:
1159         - application/json
1160         - application/xml
1161       responses:
1162         "default":
1163           description: Response codes found in [response codes](https://wiki.onap.org/).
1164       parameters:
1165         - name: cloud-owner
1166           in: path
1167           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1168           required: true
1169           type: string
1170           example: __CLOUD-OWNER__
1171         - name: cloud-region-id
1172           in: path
1173           description: Identifier used by the vendor for the region. Second part of composite key
1174           required: true
1175           type: string
1176           example: __CLOUD-REGION-ID__
1177         - name: tenant-id
1178           in: path
1179           description: Unique id relative to the cloud-region.
1180           required: true
1181           type: string
1182           example: __TENANT-ID__
1183         - name: vserver-id
1184           in: path
1185           description: Unique identifier for this vserver relative to its tenant
1186           required: true
1187           type: string
1188           example: __VSERVER-ID__
1189         - name: volume-id
1190           in: path
1191           description: Unique ID of block storage volume relative to the vserver.
1192           required: true
1193           type: string
1194           example: __VOLUME-ID__
1195         - name: resource-version
1196           in: query
1197           description: resource-version for concurrency
1198           required: true
1199           type: string
1200   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1201     get:
1202       tags:
1203         - CloudInfrastructure
1204       summary: returns volumes
1205       description: returns volumes
1206       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1207       produces:
1208         - application/json
1209         - application/xml
1210       responses:
1211         "200":
1212           description: successful operation
1213           schema:
1214               $ref: "#/getDefinitions/volumes"
1215         "default":
1216           description: Response codes found in [response codes](https://wiki.onap.org/).
1217       parameters:
1218         - name: cloud-owner
1219           in: path
1220           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1221           required: true
1222           type: string
1223           example: __CLOUD-OWNER__
1224         - name: cloud-region-id
1225           in: path
1226           description: Identifier used by the vendor for the region. Second part of composite key
1227           required: true
1228           type: string
1229           example: __CLOUD-REGION-ID__
1230         - name: tenant-id
1231           in: path
1232           description: Unique id relative to the cloud-region.
1233           required: true
1234           type: string
1235           example: __TENANT-ID__
1236         - name: vserver-id
1237           in: path
1238           description: Unique identifier for this vserver relative to its tenant
1239           required: true
1240           type: string
1241           example: __VSERVER-ID__
1242         - name: cloud-type
1243           in: query
1244           description: Type of the cloud (e.g., openstack)
1245           required: false
1246           type: string
1247         - name: owner-defined-type
1248           in: query
1249           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1250           required: false
1251           type: string
1252         - name: tenant-name
1253           in: query
1254           description: Readable name of tenant
1255           required: false
1256           type: string
1257         - name: tenant-context
1258           in: query
1259           description: This field will store the tenant context.
1260           required: false
1261           type: string
1262         - name: vserver-name
1263           in: query
1264           description: Name of vserver
1265           required: false
1266           type: string
1267         - name: vserver-name2
1268           in: query
1269           description: Alternative name of vserver
1270           required: false
1271           type: string
1272         - name: prov-status
1273           in: query
1274           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1275           required: false
1276           type: string
1277         - name: in-maint
1278           in: query
1279           required: false
1280           type: boolean
1281         - name: is-closed-loop-disabled
1282           in: query
1283           required: false
1284           type: boolean
1285   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1286     put:
1287       tags:
1288         - CloudInfrastructure
1289       summary: see node definition for valid relationships
1290       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1291       consumes:
1292         - application/json
1293         - application/xml
1294       produces:
1295         - application/json
1296         - application/xml
1297       responses:
1298         "default":
1299           description: Response codes found in [response codes](https://wiki.onap.org/).
1300       parameters:
1301         - name: cloud-owner
1302           in: path
1303           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1304           required: true
1305           type: string
1306           example: __CLOUD-OWNER__
1307         - name: cloud-region-id
1308           in: path
1309           description: Identifier used by the vendor for the region. Second part of composite key
1310           required: true
1311           type: string
1312           example: __CLOUD-REGION-ID__
1313         - name: tenant-id
1314           in: path
1315           description: Unique id relative to the cloud-region.
1316           required: true
1317           type: string
1318           example: __TENANT-ID__
1319         - name: vserver-id
1320           in: path
1321           description: Unique identifier for this vserver relative to its tenant
1322           required: true
1323           type: string
1324           example: __VSERVER-ID__
1325         - name: body
1326           in: body
1327           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1328           required: true
1329           schema:
1330             $ref: "#/definitions/relationship"
1331     delete:
1332       tags:
1333         - CloudInfrastructure
1334       summary: delete an existing relationship
1335       description: delete an existing relationship
1336       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1337       consumes:
1338         - application/json
1339         - application/xml
1340       produces:
1341         - application/json
1342         - application/xml
1343       responses:
1344         "default":
1345           description: Response codes found in [response codes](https://wiki.onap.org/).
1346       parameters:
1347         - name: cloud-owner
1348           in: path
1349           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1350           required: true
1351           type: string
1352           example: __CLOUD-OWNER__
1353         - name: cloud-region-id
1354           in: path
1355           description: Identifier used by the vendor for the region. Second part of composite key
1356           required: true
1357           type: string
1358           example: __CLOUD-REGION-ID__
1359         - name: tenant-id
1360           in: path
1361           description: Unique id relative to the cloud-region.
1362           required: true
1363           type: string
1364           example: __TENANT-ID__
1365         - name: vserver-id
1366           in: path
1367           description: Unique identifier for this vserver relative to its tenant
1368           required: true
1369           type: string
1370           example: __VSERVER-ID__
1371   /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:
1372     put:
1373       tags:
1374         - CloudInfrastructure
1375       summary: see node definition for valid relationships
1376       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1377       consumes:
1378         - application/json
1379         - application/xml
1380       produces:
1381         - application/json
1382         - application/xml
1383       responses:
1384         "default":
1385           description: Response codes found in [response codes](https://wiki.onap.org/).
1386       parameters:
1387         - name: cloud-owner
1388           in: path
1389           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1390           required: true
1391           type: string
1392           example: __CLOUD-OWNER__
1393         - name: cloud-region-id
1394           in: path
1395           description: Identifier used by the vendor for the region. Second part of composite key
1396           required: true
1397           type: string
1398           example: __CLOUD-REGION-ID__
1399         - name: tenant-id
1400           in: path
1401           description: Unique id relative to the cloud-region.
1402           required: true
1403           type: string
1404           example: __TENANT-ID__
1405         - name: vserver-id
1406           in: path
1407           description: Unique identifier for this vserver relative to its tenant
1408           required: true
1409           type: string
1410           example: __VSERVER-ID__
1411         - name: interface-name
1412           in: path
1413           description: Name given to the interface
1414           required: true
1415           type: string
1416           example: __INTERFACE-NAME__
1417         - name: vlan-interface
1418           in: path
1419           description: String that identifies the interface
1420           required: true
1421           type: string
1422           example: __VLAN-INTERFACE__
1423         - name: body
1424           in: body
1425           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1426           required: true
1427           schema:
1428             $ref: "#/definitions/relationship"
1429     delete:
1430       tags:
1431         - CloudInfrastructure
1432       summary: delete an existing relationship
1433       description: delete an existing relationship
1434       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1435       consumes:
1436         - application/json
1437         - application/xml
1438       produces:
1439         - application/json
1440         - application/xml
1441       responses:
1442         "default":
1443           description: Response codes found in [response codes](https://wiki.onap.org/).
1444       parameters:
1445         - name: cloud-owner
1446           in: path
1447           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1448           required: true
1449           type: string
1450           example: __CLOUD-OWNER__
1451         - name: cloud-region-id
1452           in: path
1453           description: Identifier used by the vendor for the region. Second part of composite key
1454           required: true
1455           type: string
1456           example: __CLOUD-REGION-ID__
1457         - name: tenant-id
1458           in: path
1459           description: Unique id relative to the cloud-region.
1460           required: true
1461           type: string
1462           example: __TENANT-ID__
1463         - name: vserver-id
1464           in: path
1465           description: Unique identifier for this vserver relative to its tenant
1466           required: true
1467           type: string
1468           example: __VSERVER-ID__
1469         - name: interface-name
1470           in: path
1471           description: Name given to the interface
1472           required: true
1473           type: string
1474           example: __INTERFACE-NAME__
1475         - name: vlan-interface
1476           in: path
1477           description: String that identifies the interface
1478           required: true
1479           type: string
1480           example: __VLAN-INTERFACE__
1481   /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:
1482     put:
1483       tags:
1484         - CloudInfrastructure
1485       summary: see node definition for valid relationships
1486       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1487       consumes:
1488         - application/json
1489         - application/xml
1490       produces:
1491         - application/json
1492         - application/xml
1493       responses:
1494         "default":
1495           description: Response codes found in [response codes](https://wiki.onap.org/).
1496       parameters:
1497         - name: cloud-owner
1498           in: path
1499           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1500           required: true
1501           type: string
1502           example: __CLOUD-OWNER__
1503         - name: cloud-region-id
1504           in: path
1505           description: Identifier used by the vendor for the region. Second part of composite key
1506           required: true
1507           type: string
1508           example: __CLOUD-REGION-ID__
1509         - name: tenant-id
1510           in: path
1511           description: Unique id relative to the cloud-region.
1512           required: true
1513           type: string
1514           example: __TENANT-ID__
1515         - name: vserver-id
1516           in: path
1517           description: Unique identifier for this vserver relative to its tenant
1518           required: true
1519           type: string
1520           example: __VSERVER-ID__
1521         - name: interface-name
1522           in: path
1523           description: Name given to the interface
1524           required: true
1525           type: string
1526           example: __INTERFACE-NAME__
1527         - name: vlan-interface
1528           in: path
1529           description: String that identifies the interface
1530           required: true
1531           type: string
1532           example: __VLAN-INTERFACE__
1533         - name: l3-interface-ipv4-address
1534           in: path
1535           description: IP address
1536           required: true
1537           type: string
1538           example: __L3-INTERFACE-IPV4-ADDRESS__
1539         - name: body
1540           in: body
1541           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1542           required: true
1543           schema:
1544             $ref: "#/definitions/relationship"
1545     delete:
1546       tags:
1547         - CloudInfrastructure
1548       summary: delete an existing relationship
1549       description: delete an existing relationship
1550       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1551       consumes:
1552         - application/json
1553         - application/xml
1554       produces:
1555         - application/json
1556         - application/xml
1557       responses:
1558         "default":
1559           description: Response codes found in [response codes](https://wiki.onap.org/).
1560       parameters:
1561         - name: cloud-owner
1562           in: path
1563           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1564           required: true
1565           type: string
1566           example: __CLOUD-OWNER__
1567         - name: cloud-region-id
1568           in: path
1569           description: Identifier used by the vendor for the region. Second part of composite key
1570           required: true
1571           type: string
1572           example: __CLOUD-REGION-ID__
1573         - name: tenant-id
1574           in: path
1575           description: Unique id relative to the cloud-region.
1576           required: true
1577           type: string
1578           example: __TENANT-ID__
1579         - name: vserver-id
1580           in: path
1581           description: Unique identifier for this vserver relative to its tenant
1582           required: true
1583           type: string
1584           example: __VSERVER-ID__
1585         - name: interface-name
1586           in: path
1587           description: Name given to the interface
1588           required: true
1589           type: string
1590           example: __INTERFACE-NAME__
1591         - name: vlan-interface
1592           in: path
1593           description: String that identifies the interface
1594           required: true
1595           type: string
1596           example: __VLAN-INTERFACE__
1597         - name: l3-interface-ipv4-address
1598           in: path
1599           description: IP address
1600           required: true
1601           type: string
1602           example: __L3-INTERFACE-IPV4-ADDRESS__
1603   /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}:
1604     get:
1605       tags:
1606         - CloudInfrastructure
1607       summary: returns l3-interface-ipv4-address-list
1608       description: returns l3-interface-ipv4-address-list
1609       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1610       produces:
1611         - application/json
1612         - application/xml
1613       responses:
1614         "200":
1615           description: successful operation
1616           schema:
1617               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1618         "default":
1619           description: Response codes found in [response codes](https://wiki.onap.org/).
1620       parameters:
1621         - name: cloud-owner
1622           in: path
1623           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1624           required: true
1625           type: string
1626           example: __CLOUD-OWNER__
1627         - name: cloud-region-id
1628           in: path
1629           description: Identifier used by the vendor for the region. Second part of composite key
1630           required: true
1631           type: string
1632           example: __CLOUD-REGION-ID__
1633         - name: tenant-id
1634           in: path
1635           description: Unique id relative to the cloud-region.
1636           required: true
1637           type: string
1638           example: __TENANT-ID__
1639         - name: vserver-id
1640           in: path
1641           description: Unique identifier for this vserver relative to its tenant
1642           required: true
1643           type: string
1644           example: __VSERVER-ID__
1645         - name: interface-name
1646           in: path
1647           description: Name given to the interface
1648           required: true
1649           type: string
1650           example: __INTERFACE-NAME__
1651         - name: vlan-interface
1652           in: path
1653           description: String that identifies the interface
1654           required: true
1655           type: string
1656           example: __VLAN-INTERFACE__
1657         - name: l3-interface-ipv4-address
1658           in: path
1659           description: IP address
1660           required: true
1661           type: string
1662           example: __L3-INTERFACE-IPV4-ADDRESS__
1663         - name: cloud-type
1664           in: query
1665           description: Type of the cloud (e.g., openstack)
1666           required: false
1667           type: string
1668         - name: owner-defined-type
1669           in: query
1670           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1671           required: false
1672           type: string
1673         - name: tenant-name
1674           in: query
1675           description: Readable name of tenant
1676           required: false
1677           type: string
1678         - name: tenant-context
1679           in: query
1680           description: This field will store the tenant context.
1681           required: false
1682           type: string
1683         - name: vserver-name
1684           in: query
1685           description: Name of vserver
1686           required: false
1687           type: string
1688         - name: vserver-name2
1689           in: query
1690           description: Alternative name of vserver
1691           required: false
1692           type: string
1693         - name: prov-status
1694           in: query
1695           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1696           required: false
1697           type: string
1698         - name: in-maint
1699           in: query
1700           required: false
1701           type: boolean
1702         - name: is-closed-loop-disabled
1703           in: query
1704           required: false
1705           type: boolean
1706         - name: interface-id
1707           in: query
1708           description: ID of interface
1709           required: false
1710           type: string
1711         - name: macaddr
1712           in: query
1713           description: MAC address for the interface
1714           required: false
1715           type: string
1716         - name: network-name
1717           in: query
1718           description: Name of the network
1719           required: false
1720           type: string
1721         - name: vlan-id-inner
1722           in: query
1723           description: Inner VLAN tag
1724           required: false
1725           type: integer
1726           format: int64
1727         - name: vpn-key
1728           in: query
1729           description: This indicates the customers VPN ID associated with this vlan
1730           required: false
1731           type: string
1732         - name: vlan-id-inner
1733           in: query
1734           description: Inner VLAN tag
1735           required: false
1736           type: integer
1737           format: int64
1738         - name: neutron-network-id
1739           in: query
1740           description: Neutron network id of the interface that address belongs to
1741           required: false
1742           type: string
1743         - name: neutron-subnet-id
1744           in: query
1745           description: Neutron id of subnet that address belongs to
1746           required: false
1747           type: string
1748     put:
1749       tags:
1750         - CloudInfrastructure
1751       summary: create or update an existing l3-interface-ipv4-address-list
1752       description: |
1753         Create or update an existing l3-interface-ipv4-address-list.
1754         #
1755         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
1756       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1757       consumes:
1758         - application/json
1759         - application/xml
1760       produces:
1761         - application/json
1762         - application/xml
1763       responses:
1764         "default":
1765           description: Response codes found in [response codes](https://wiki.onap.org/).
1766       parameters:
1767         - name: cloud-owner
1768           in: path
1769           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1770           required: true
1771           type: string
1772           example: __CLOUD-OWNER__
1773         - name: cloud-region-id
1774           in: path
1775           description: Identifier used by the vendor for the region. Second part of composite key
1776           required: true
1777           type: string
1778           example: __CLOUD-REGION-ID__
1779         - name: tenant-id
1780           in: path
1781           description: Unique id relative to the cloud-region.
1782           required: true
1783           type: string
1784           example: __TENANT-ID__
1785         - name: vserver-id
1786           in: path
1787           description: Unique identifier for this vserver relative to its tenant
1788           required: true
1789           type: string
1790           example: __VSERVER-ID__
1791         - name: interface-name
1792           in: path
1793           description: Name given to the interface
1794           required: true
1795           type: string
1796           example: __INTERFACE-NAME__
1797         - name: vlan-interface
1798           in: path
1799           description: String that identifies the interface
1800           required: true
1801           type: string
1802           example: __VLAN-INTERFACE__
1803         - name: l3-interface-ipv4-address
1804           in: path
1805           description: IP address
1806           required: true
1807           type: string
1808           example: __L3-INTERFACE-IPV4-ADDRESS__
1809         - name: body
1810           in: body
1811           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1812           required: true
1813           schema:
1814             $ref: "#/definitions/l3-interface-ipv4-address-list"
1815     patch:
1816       tags:
1817         - CloudInfrastructure
1818       summary: update an existing l3-interface-ipv4-address-list
1819       description: |
1820         Update an existing l3-interface-ipv4-address-list
1821         #
1822         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1823         The PUT operation will entirely replace an existing object.
1824         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.
1825         #
1826         Other differences between PUT and PATCH are:
1827         #
1828         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1829         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1830         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1831       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1832       consumes:
1833         - application/json
1834         - application/xml
1835       produces:
1836         - application/json
1837         - application/xml
1838       responses:
1839         "default":
1840           description: Response codes found in [response codes](https://wiki.onap.org/).
1841       parameters:
1842         - name: cloud-owner
1843           in: path
1844           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1845           required: true
1846           type: string
1847           example: __CLOUD-OWNER__
1848         - name: cloud-region-id
1849           in: path
1850           description: Identifier used by the vendor for the region. Second part of composite key
1851           required: true
1852           type: string
1853           example: __CLOUD-REGION-ID__
1854         - name: tenant-id
1855           in: path
1856           description: Unique id relative to the cloud-region.
1857           required: true
1858           type: string
1859           example: __TENANT-ID__
1860         - name: vserver-id
1861           in: path
1862           description: Unique identifier for this vserver relative to its tenant
1863           required: true
1864           type: string
1865           example: __VSERVER-ID__
1866         - name: interface-name
1867           in: path
1868           description: Name given to the interface
1869           required: true
1870           type: string
1871           example: __INTERFACE-NAME__
1872         - name: vlan-interface
1873           in: path
1874           description: String that identifies the interface
1875           required: true
1876           type: string
1877           example: __VLAN-INTERFACE__
1878         - name: l3-interface-ipv4-address
1879           in: path
1880           description: IP address
1881           required: true
1882           type: string
1883           example: __L3-INTERFACE-IPV4-ADDRESS__
1884         - name: body
1885           in: body
1886           description: l3-interface-ipv4-address-list object that needs to be created or updated.
1887           required: true
1888           schema:
1889             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1890     delete:
1891       tags:
1892         - CloudInfrastructure
1893       summary: delete an existing l3-interface-ipv4-address-list
1894       description: delete an existing l3-interface-ipv4-address-list
1895       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1896       consumes:
1897         - application/json
1898         - application/xml
1899       produces:
1900         - application/json
1901         - application/xml
1902       responses:
1903         "default":
1904           description: Response codes found in [response codes](https://wiki.onap.org/).
1905       parameters:
1906         - name: cloud-owner
1907           in: path
1908           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1909           required: true
1910           type: string
1911           example: __CLOUD-OWNER__
1912         - name: cloud-region-id
1913           in: path
1914           description: Identifier used by the vendor for the region. Second part of composite key
1915           required: true
1916           type: string
1917           example: __CLOUD-REGION-ID__
1918         - name: tenant-id
1919           in: path
1920           description: Unique id relative to the cloud-region.
1921           required: true
1922           type: string
1923           example: __TENANT-ID__
1924         - name: vserver-id
1925           in: path
1926           description: Unique identifier for this vserver relative to its tenant
1927           required: true
1928           type: string
1929           example: __VSERVER-ID__
1930         - name: interface-name
1931           in: path
1932           description: Name given to the interface
1933           required: true
1934           type: string
1935           example: __INTERFACE-NAME__
1936         - name: vlan-interface
1937           in: path
1938           description: String that identifies the interface
1939           required: true
1940           type: string
1941           example: __VLAN-INTERFACE__
1942         - name: l3-interface-ipv4-address
1943           in: path
1944           description: IP address
1945           required: true
1946           type: string
1947           example: __L3-INTERFACE-IPV4-ADDRESS__
1948         - name: resource-version
1949           in: query
1950           description: resource-version for concurrency
1951           required: true
1952           type: string
1953   /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:
1954     put:
1955       tags:
1956         - CloudInfrastructure
1957       summary: see node definition for valid relationships
1958       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1959       consumes:
1960         - application/json
1961         - application/xml
1962       produces:
1963         - application/json
1964         - application/xml
1965       responses:
1966         "default":
1967           description: Response codes found in [response codes](https://wiki.onap.org/).
1968       parameters:
1969         - name: cloud-owner
1970           in: path
1971           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1972           required: true
1973           type: string
1974           example: __CLOUD-OWNER__
1975         - name: cloud-region-id
1976           in: path
1977           description: Identifier used by the vendor for the region. Second part of composite key
1978           required: true
1979           type: string
1980           example: __CLOUD-REGION-ID__
1981         - name: tenant-id
1982           in: path
1983           description: Unique id relative to the cloud-region.
1984           required: true
1985           type: string
1986           example: __TENANT-ID__
1987         - name: vserver-id
1988           in: path
1989           description: Unique identifier for this vserver relative to its tenant
1990           required: true
1991           type: string
1992           example: __VSERVER-ID__
1993         - name: interface-name
1994           in: path
1995           description: Name given to the interface
1996           required: true
1997           type: string
1998           example: __INTERFACE-NAME__
1999         - name: vlan-interface
2000           in: path
2001           description: String that identifies the interface
2002           required: true
2003           type: string
2004           example: __VLAN-INTERFACE__
2005         - name: l3-interface-ipv6-address
2006           in: path
2007           description: IP address
2008           required: true
2009           type: string
2010           example: __L3-INTERFACE-IPV6-ADDRESS__
2011         - name: body
2012           in: body
2013           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2014           required: true
2015           schema:
2016             $ref: "#/definitions/relationship"
2017     delete:
2018       tags:
2019         - CloudInfrastructure
2020       summary: delete an existing relationship
2021       description: delete an existing relationship
2022       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
2023       consumes:
2024         - application/json
2025         - application/xml
2026       produces:
2027         - application/json
2028         - application/xml
2029       responses:
2030         "default":
2031           description: Response codes found in [response codes](https://wiki.onap.org/).
2032       parameters:
2033         - name: cloud-owner
2034           in: path
2035           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2036           required: true
2037           type: string
2038           example: __CLOUD-OWNER__
2039         - name: cloud-region-id
2040           in: path
2041           description: Identifier used by the vendor for the region. Second part of composite key
2042           required: true
2043           type: string
2044           example: __CLOUD-REGION-ID__
2045         - name: tenant-id
2046           in: path
2047           description: Unique id relative to the cloud-region.
2048           required: true
2049           type: string
2050           example: __TENANT-ID__
2051         - name: vserver-id
2052           in: path
2053           description: Unique identifier for this vserver relative to its tenant
2054           required: true
2055           type: string
2056           example: __VSERVER-ID__
2057         - name: interface-name
2058           in: path
2059           description: Name given to the interface
2060           required: true
2061           type: string
2062           example: __INTERFACE-NAME__
2063         - name: vlan-interface
2064           in: path
2065           description: String that identifies the interface
2066           required: true
2067           type: string
2068           example: __VLAN-INTERFACE__
2069         - name: l3-interface-ipv6-address
2070           in: path
2071           description: IP address
2072           required: true
2073           type: string
2074           example: __L3-INTERFACE-IPV6-ADDRESS__
2075   /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}:
2076     get:
2077       tags:
2078         - CloudInfrastructure
2079       summary: returns l3-interface-ipv6-address-list
2080       description: returns l3-interface-ipv6-address-list
2081       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2082       produces:
2083         - application/json
2084         - application/xml
2085       responses:
2086         "200":
2087           description: successful operation
2088           schema:
2089               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
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: cloud-type
2136           in: query
2137           description: Type of the cloud (e.g., openstack)
2138           required: false
2139           type: string
2140         - name: owner-defined-type
2141           in: query
2142           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2143           required: false
2144           type: string
2145         - name: tenant-name
2146           in: query
2147           description: Readable name of tenant
2148           required: false
2149           type: string
2150         - name: tenant-context
2151           in: query
2152           description: This field will store the tenant context.
2153           required: false
2154           type: string
2155         - name: vserver-name
2156           in: query
2157           description: Name of vserver
2158           required: false
2159           type: string
2160         - name: vserver-name2
2161           in: query
2162           description: Alternative name of vserver
2163           required: false
2164           type: string
2165         - name: prov-status
2166           in: query
2167           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2168           required: false
2169           type: string
2170         - name: in-maint
2171           in: query
2172           required: false
2173           type: boolean
2174         - name: is-closed-loop-disabled
2175           in: query
2176           required: false
2177           type: boolean
2178         - name: interface-id
2179           in: query
2180           description: ID of interface
2181           required: false
2182           type: string
2183         - name: macaddr
2184           in: query
2185           description: MAC address for the interface
2186           required: false
2187           type: string
2188         - name: network-name
2189           in: query
2190           description: Name of the network
2191           required: false
2192           type: string
2193         - name: vlan-id-inner
2194           in: query
2195           description: Inner VLAN tag
2196           required: false
2197           type: integer
2198           format: int64
2199         - name: vpn-key
2200           in: query
2201           description: This indicates the customers VPN ID associated with this vlan
2202           required: false
2203           type: string
2204         - name: vlan-id-inner
2205           in: query
2206           description: Inner VLAN tag
2207           required: false
2208           type: integer
2209           format: int64
2210         - name: neutron-network-id
2211           in: query
2212           description: Neutron network id of the interface that address belongs to
2213           required: false
2214           type: string
2215         - name: neutron-subnet-id
2216           in: query
2217           description: Neutron id of subnet that address belongs to
2218           required: false
2219           type: string
2220     put:
2221       tags:
2222         - CloudInfrastructure
2223       summary: create or update an existing l3-interface-ipv6-address-list
2224       description: |
2225         Create or update an existing l3-interface-ipv6-address-list.
2226         #
2227         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
2228       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2229       consumes:
2230         - application/json
2231         - application/xml
2232       produces:
2233         - application/json
2234         - application/xml
2235       responses:
2236         "default":
2237           description: Response codes found in [response codes](https://wiki.onap.org/).
2238       parameters:
2239         - name: cloud-owner
2240           in: path
2241           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2242           required: true
2243           type: string
2244           example: __CLOUD-OWNER__
2245         - name: cloud-region-id
2246           in: path
2247           description: Identifier used by the vendor for the region. Second part of composite key
2248           required: true
2249           type: string
2250           example: __CLOUD-REGION-ID__
2251         - name: tenant-id
2252           in: path
2253           description: Unique id relative to the cloud-region.
2254           required: true
2255           type: string
2256           example: __TENANT-ID__
2257         - name: vserver-id
2258           in: path
2259           description: Unique identifier for this vserver relative to its tenant
2260           required: true
2261           type: string
2262           example: __VSERVER-ID__
2263         - name: interface-name
2264           in: path
2265           description: Name given to the interface
2266           required: true
2267           type: string
2268           example: __INTERFACE-NAME__
2269         - name: vlan-interface
2270           in: path
2271           description: String that identifies the interface
2272           required: true
2273           type: string
2274           example: __VLAN-INTERFACE__
2275         - name: l3-interface-ipv6-address
2276           in: path
2277           description: IP address
2278           required: true
2279           type: string
2280           example: __L3-INTERFACE-IPV6-ADDRESS__
2281         - name: body
2282           in: body
2283           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2284           required: true
2285           schema:
2286             $ref: "#/definitions/l3-interface-ipv6-address-list"
2287     patch:
2288       tags:
2289         - CloudInfrastructure
2290       summary: update an existing l3-interface-ipv6-address-list
2291       description: |
2292         Update an existing l3-interface-ipv6-address-list
2293         #
2294         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2295         The PUT operation will entirely replace an existing object.
2296         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.
2297         #
2298         Other differences between PUT and PATCH are:
2299         #
2300         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2301         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2302         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2303       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2304       consumes:
2305         - application/json
2306         - application/xml
2307       produces:
2308         - application/json
2309         - application/xml
2310       responses:
2311         "default":
2312           description: Response codes found in [response codes](https://wiki.onap.org/).
2313       parameters:
2314         - name: cloud-owner
2315           in: path
2316           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2317           required: true
2318           type: string
2319           example: __CLOUD-OWNER__
2320         - name: cloud-region-id
2321           in: path
2322           description: Identifier used by the vendor for the region. Second part of composite key
2323           required: true
2324           type: string
2325           example: __CLOUD-REGION-ID__
2326         - name: tenant-id
2327           in: path
2328           description: Unique id relative to the cloud-region.
2329           required: true
2330           type: string
2331           example: __TENANT-ID__
2332         - name: vserver-id
2333           in: path
2334           description: Unique identifier for this vserver relative to its tenant
2335           required: true
2336           type: string
2337           example: __VSERVER-ID__
2338         - name: interface-name
2339           in: path
2340           description: Name given to the interface
2341           required: true
2342           type: string
2343           example: __INTERFACE-NAME__
2344         - name: vlan-interface
2345           in: path
2346           description: String that identifies the interface
2347           required: true
2348           type: string
2349           example: __VLAN-INTERFACE__
2350         - name: l3-interface-ipv6-address
2351           in: path
2352           description: IP address
2353           required: true
2354           type: string
2355           example: __L3-INTERFACE-IPV6-ADDRESS__
2356         - name: body
2357           in: body
2358           description: l3-interface-ipv6-address-list object that needs to be created or updated.
2359           required: true
2360           schema:
2361             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2362     delete:
2363       tags:
2364         - CloudInfrastructure
2365       summary: delete an existing l3-interface-ipv6-address-list
2366       description: delete an existing l3-interface-ipv6-address-list
2367       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2368       consumes:
2369         - application/json
2370         - application/xml
2371       produces:
2372         - application/json
2373         - application/xml
2374       responses:
2375         "default":
2376           description: Response codes found in [response codes](https://wiki.onap.org/).
2377       parameters:
2378         - name: cloud-owner
2379           in: path
2380           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2381           required: true
2382           type: string
2383           example: __CLOUD-OWNER__
2384         - name: cloud-region-id
2385           in: path
2386           description: Identifier used by the vendor for the region. Second part of composite key
2387           required: true
2388           type: string
2389           example: __CLOUD-REGION-ID__
2390         - name: tenant-id
2391           in: path
2392           description: Unique id relative to the cloud-region.
2393           required: true
2394           type: string
2395           example: __TENANT-ID__
2396         - name: vserver-id
2397           in: path
2398           description: Unique identifier for this vserver relative to its tenant
2399           required: true
2400           type: string
2401           example: __VSERVER-ID__
2402         - name: interface-name
2403           in: path
2404           description: Name given to the interface
2405           required: true
2406           type: string
2407           example: __INTERFACE-NAME__
2408         - name: vlan-interface
2409           in: path
2410           description: String that identifies the interface
2411           required: true
2412           type: string
2413           example: __VLAN-INTERFACE__
2414         - name: l3-interface-ipv6-address
2415           in: path
2416           description: IP address
2417           required: true
2418           type: string
2419           example: __L3-INTERFACE-IPV6-ADDRESS__
2420         - name: resource-version
2421           in: query
2422           description: resource-version for concurrency
2423           required: true
2424           type: string
2425   /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}:
2426     get:
2427       tags:
2428         - CloudInfrastructure
2429       summary: returns vlan
2430       description: returns vlan
2431       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2432       produces:
2433         - application/json
2434         - application/xml
2435       responses:
2436         "200":
2437           description: successful operation
2438           schema:
2439               $ref: "#/getDefinitions/vlan"
2440         "default":
2441           description: Response codes found in [response codes](https://wiki.onap.org/).
2442       parameters:
2443         - name: cloud-owner
2444           in: path
2445           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2446           required: true
2447           type: string
2448           example: __CLOUD-OWNER__
2449         - name: cloud-region-id
2450           in: path
2451           description: Identifier used by the vendor for the region. Second part of composite key
2452           required: true
2453           type: string
2454           example: __CLOUD-REGION-ID__
2455         - name: tenant-id
2456           in: path
2457           description: Unique id relative to the cloud-region.
2458           required: true
2459           type: string
2460           example: __TENANT-ID__
2461         - name: vserver-id
2462           in: path
2463           description: Unique identifier for this vserver relative to its tenant
2464           required: true
2465           type: string
2466           example: __VSERVER-ID__
2467         - name: interface-name
2468           in: path
2469           description: Name given to the interface
2470           required: true
2471           type: string
2472           example: __INTERFACE-NAME__
2473         - name: vlan-interface
2474           in: path
2475           description: String that identifies the interface
2476           required: true
2477           type: string
2478           example: __VLAN-INTERFACE__
2479         - name: cloud-type
2480           in: query
2481           description: Type of the cloud (e.g., openstack)
2482           required: false
2483           type: string
2484         - name: owner-defined-type
2485           in: query
2486           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2487           required: false
2488           type: string
2489         - name: tenant-name
2490           in: query
2491           description: Readable name of tenant
2492           required: false
2493           type: string
2494         - name: tenant-context
2495           in: query
2496           description: This field will store the tenant context.
2497           required: false
2498           type: string
2499         - name: vserver-name
2500           in: query
2501           description: Name of vserver
2502           required: false
2503           type: string
2504         - name: vserver-name2
2505           in: query
2506           description: Alternative name of vserver
2507           required: false
2508           type: string
2509         - name: prov-status
2510           in: query
2511           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2512           required: false
2513           type: string
2514         - name: in-maint
2515           in: query
2516           required: false
2517           type: boolean
2518         - name: is-closed-loop-disabled
2519           in: query
2520           required: false
2521           type: boolean
2522         - name: interface-id
2523           in: query
2524           description: ID of interface
2525           required: false
2526           type: string
2527         - name: macaddr
2528           in: query
2529           description: MAC address for the interface
2530           required: false
2531           type: string
2532         - name: network-name
2533           in: query
2534           description: Name of the network
2535           required: false
2536           type: string
2537         - name: vlan-id-inner
2538           in: query
2539           description: Inner VLAN tag
2540           required: false
2541           type: integer
2542           format: int64
2543         - name: vpn-key
2544           in: query
2545           description: This indicates the customers VPN ID associated with this vlan
2546           required: false
2547           type: string
2548     put:
2549       tags:
2550         - CloudInfrastructure
2551       summary: create or update an existing vlan
2552       description: |
2553         Create or update an existing vlan.
2554         #
2555         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
2556       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2557       consumes:
2558         - application/json
2559         - application/xml
2560       produces:
2561         - application/json
2562         - application/xml
2563       responses:
2564         "default":
2565           description: Response codes found in [response codes](https://wiki.onap.org/).
2566       parameters:
2567         - name: cloud-owner
2568           in: path
2569           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2570           required: true
2571           type: string
2572           example: __CLOUD-OWNER__
2573         - name: cloud-region-id
2574           in: path
2575           description: Identifier used by the vendor for the region. Second part of composite key
2576           required: true
2577           type: string
2578           example: __CLOUD-REGION-ID__
2579         - name: tenant-id
2580           in: path
2581           description: Unique id relative to the cloud-region.
2582           required: true
2583           type: string
2584           example: __TENANT-ID__
2585         - name: vserver-id
2586           in: path
2587           description: Unique identifier for this vserver relative to its tenant
2588           required: true
2589           type: string
2590           example: __VSERVER-ID__
2591         - name: interface-name
2592           in: path
2593           description: Name given to the interface
2594           required: true
2595           type: string
2596           example: __INTERFACE-NAME__
2597         - name: vlan-interface
2598           in: path
2599           description: String that identifies the interface
2600           required: true
2601           type: string
2602           example: __VLAN-INTERFACE__
2603         - name: body
2604           in: body
2605           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2606           required: true
2607           schema:
2608             $ref: "#/definitions/vlan"
2609     patch:
2610       tags:
2611         - CloudInfrastructure
2612       summary: update an existing vlan
2613       description: |
2614         Update an existing vlan
2615         #
2616         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2617         The PUT operation will entirely replace an existing object.
2618         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.
2619         #
2620         Other differences between PUT and PATCH are:
2621         #
2622         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2623         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2624         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2625       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2626       consumes:
2627         - application/json
2628         - application/xml
2629       produces:
2630         - application/json
2631         - application/xml
2632       responses:
2633         "default":
2634           description: Response codes found in [response codes](https://wiki.onap.org/).
2635       parameters:
2636         - name: cloud-owner
2637           in: path
2638           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2639           required: true
2640           type: string
2641           example: __CLOUD-OWNER__
2642         - name: cloud-region-id
2643           in: path
2644           description: Identifier used by the vendor for the region. Second part of composite key
2645           required: true
2646           type: string
2647           example: __CLOUD-REGION-ID__
2648         - name: tenant-id
2649           in: path
2650           description: Unique id relative to the cloud-region.
2651           required: true
2652           type: string
2653           example: __TENANT-ID__
2654         - name: vserver-id
2655           in: path
2656           description: Unique identifier for this vserver relative to its tenant
2657           required: true
2658           type: string
2659           example: __VSERVER-ID__
2660         - name: interface-name
2661           in: path
2662           description: Name given to the interface
2663           required: true
2664           type: string
2665           example: __INTERFACE-NAME__
2666         - name: vlan-interface
2667           in: path
2668           description: String that identifies the interface
2669           required: true
2670           type: string
2671           example: __VLAN-INTERFACE__
2672         - name: body
2673           in: body
2674           description: vlan object that needs to be created or updated.
2675           required: true
2676           schema:
2677             $ref: "#/patchDefinitions/vlan"
2678     delete:
2679       tags:
2680         - CloudInfrastructure
2681       summary: delete an existing vlan
2682       description: delete an existing vlan
2683       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2684       consumes:
2685         - application/json
2686         - application/xml
2687       produces:
2688         - application/json
2689         - application/xml
2690       responses:
2691         "default":
2692           description: Response codes found in [response codes](https://wiki.onap.org/).
2693       parameters:
2694         - name: cloud-owner
2695           in: path
2696           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2697           required: true
2698           type: string
2699           example: __CLOUD-OWNER__
2700         - name: cloud-region-id
2701           in: path
2702           description: Identifier used by the vendor for the region. Second part of composite key
2703           required: true
2704           type: string
2705           example: __CLOUD-REGION-ID__
2706         - name: tenant-id
2707           in: path
2708           description: Unique id relative to the cloud-region.
2709           required: true
2710           type: string
2711           example: __TENANT-ID__
2712         - name: vserver-id
2713           in: path
2714           description: Unique identifier for this vserver relative to its tenant
2715           required: true
2716           type: string
2717           example: __VSERVER-ID__
2718         - name: interface-name
2719           in: path
2720           description: Name given to the interface
2721           required: true
2722           type: string
2723           example: __INTERFACE-NAME__
2724         - name: vlan-interface
2725           in: path
2726           description: String that identifies the interface
2727           required: true
2728           type: string
2729           example: __VLAN-INTERFACE__
2730         - name: resource-version
2731           in: query
2732           description: resource-version for concurrency
2733           required: true
2734           type: string
2735   /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:
2736     get:
2737       tags:
2738         - CloudInfrastructure
2739       summary: returns vlans
2740       description: returns vlans
2741       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2742       produces:
2743         - application/json
2744         - application/xml
2745       responses:
2746         "200":
2747           description: successful operation
2748           schema:
2749               $ref: "#/getDefinitions/vlans"
2750         "default":
2751           description: Response codes found in [response codes](https://wiki.onap.org/).
2752       parameters:
2753         - name: cloud-owner
2754           in: path
2755           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2756           required: true
2757           type: string
2758           example: __CLOUD-OWNER__
2759         - name: cloud-region-id
2760           in: path
2761           description: Identifier used by the vendor for the region. Second part of composite key
2762           required: true
2763           type: string
2764           example: __CLOUD-REGION-ID__
2765         - name: tenant-id
2766           in: path
2767           description: Unique id relative to the cloud-region.
2768           required: true
2769           type: string
2770           example: __TENANT-ID__
2771         - name: vserver-id
2772           in: path
2773           description: Unique identifier for this vserver relative to its tenant
2774           required: true
2775           type: string
2776           example: __VSERVER-ID__
2777         - name: interface-name
2778           in: path
2779           description: Name given to the interface
2780           required: true
2781           type: string
2782           example: __INTERFACE-NAME__
2783         - name: cloud-type
2784           in: query
2785           description: Type of the cloud (e.g., openstack)
2786           required: false
2787           type: string
2788         - name: owner-defined-type
2789           in: query
2790           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2791           required: false
2792           type: string
2793         - name: tenant-name
2794           in: query
2795           description: Readable name of tenant
2796           required: false
2797           type: string
2798         - name: tenant-context
2799           in: query
2800           description: This field will store the tenant context.
2801           required: false
2802           type: string
2803         - name: vserver-name
2804           in: query
2805           description: Name of vserver
2806           required: false
2807           type: string
2808         - name: vserver-name2
2809           in: query
2810           description: Alternative name of vserver
2811           required: false
2812           type: string
2813         - name: prov-status
2814           in: query
2815           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2816           required: false
2817           type: string
2818         - name: in-maint
2819           in: query
2820           required: false
2821           type: boolean
2822         - name: is-closed-loop-disabled
2823           in: query
2824           required: false
2825           type: boolean
2826         - name: interface-id
2827           in: query
2828           description: ID of interface
2829           required: false
2830           type: string
2831         - name: macaddr
2832           in: query
2833           description: MAC address for the interface
2834           required: false
2835           type: string
2836         - name: network-name
2837           in: query
2838           description: Name of the network
2839           required: false
2840           type: string
2841   /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:
2842     put:
2843       tags:
2844         - CloudInfrastructure
2845       summary: see node definition for valid relationships
2846       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2847       consumes:
2848         - application/json
2849         - application/xml
2850       produces:
2851         - application/json
2852         - application/xml
2853       responses:
2854         "default":
2855           description: Response codes found in [response codes](https://wiki.onap.org/).
2856       parameters:
2857         - name: cloud-owner
2858           in: path
2859           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2860           required: true
2861           type: string
2862           example: __CLOUD-OWNER__
2863         - name: cloud-region-id
2864           in: path
2865           description: Identifier used by the vendor for the region. Second part of composite key
2866           required: true
2867           type: string
2868           example: __CLOUD-REGION-ID__
2869         - name: tenant-id
2870           in: path
2871           description: Unique id relative to the cloud-region.
2872           required: true
2873           type: string
2874           example: __TENANT-ID__
2875         - name: vserver-id
2876           in: path
2877           description: Unique identifier for this vserver relative to its tenant
2878           required: true
2879           type: string
2880           example: __VSERVER-ID__
2881         - name: interface-name
2882           in: path
2883           description: Name given to the interface
2884           required: true
2885           type: string
2886           example: __INTERFACE-NAME__
2887         - name: pci-id
2888           in: path
2889           description: PCI ID used to identify the sriov-vf
2890           required: true
2891           type: string
2892           example: __PCI-ID__
2893         - name: body
2894           in: body
2895           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2896           required: true
2897           schema:
2898             $ref: "#/definitions/relationship"
2899     delete:
2900       tags:
2901         - CloudInfrastructure
2902       summary: delete an existing relationship
2903       description: delete an existing relationship
2904       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2905       consumes:
2906         - application/json
2907         - application/xml
2908       produces:
2909         - application/json
2910         - application/xml
2911       responses:
2912         "default":
2913           description: Response codes found in [response codes](https://wiki.onap.org/).
2914       parameters:
2915         - name: cloud-owner
2916           in: path
2917           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2918           required: true
2919           type: string
2920           example: __CLOUD-OWNER__
2921         - name: cloud-region-id
2922           in: path
2923           description: Identifier used by the vendor for the region. Second part of composite key
2924           required: true
2925           type: string
2926           example: __CLOUD-REGION-ID__
2927         - name: tenant-id
2928           in: path
2929           description: Unique id relative to the cloud-region.
2930           required: true
2931           type: string
2932           example: __TENANT-ID__
2933         - name: vserver-id
2934           in: path
2935           description: Unique identifier for this vserver relative to its tenant
2936           required: true
2937           type: string
2938           example: __VSERVER-ID__
2939         - name: interface-name
2940           in: path
2941           description: Name given to the interface
2942           required: true
2943           type: string
2944           example: __INTERFACE-NAME__
2945         - name: pci-id
2946           in: path
2947           description: PCI ID used to identify the sriov-vf
2948           required: true
2949           type: string
2950           example: __PCI-ID__
2951   /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}:
2952     get:
2953       tags:
2954         - CloudInfrastructure
2955       summary: returns sriov-vf
2956       description: returns sriov-vf
2957       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2958       produces:
2959         - application/json
2960         - application/xml
2961       responses:
2962         "200":
2963           description: successful operation
2964           schema:
2965               $ref: "#/getDefinitions/sriov-vf"
2966         "default":
2967           description: Response codes found in [response codes](https://wiki.onap.org/).
2968       parameters:
2969         - name: cloud-owner
2970           in: path
2971           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2972           required: true
2973           type: string
2974           example: __CLOUD-OWNER__
2975         - name: cloud-region-id
2976           in: path
2977           description: Identifier used by the vendor for the region. Second part of composite key
2978           required: true
2979           type: string
2980           example: __CLOUD-REGION-ID__
2981         - name: tenant-id
2982           in: path
2983           description: Unique id relative to the cloud-region.
2984           required: true
2985           type: string
2986           example: __TENANT-ID__
2987         - name: vserver-id
2988           in: path
2989           description: Unique identifier for this vserver relative to its tenant
2990           required: true
2991           type: string
2992           example: __VSERVER-ID__
2993         - name: interface-name
2994           in: path
2995           description: Name given to the interface
2996           required: true
2997           type: string
2998           example: __INTERFACE-NAME__
2999         - name: pci-id
3000           in: path
3001           description: PCI ID used to identify the sriov-vf
3002           required: true
3003           type: string
3004           example: __PCI-ID__
3005         - name: cloud-type
3006           in: query
3007           description: Type of the cloud (e.g., openstack)
3008           required: false
3009           type: string
3010         - name: owner-defined-type
3011           in: query
3012           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3013           required: false
3014           type: string
3015         - name: tenant-name
3016           in: query
3017           description: Readable name of tenant
3018           required: false
3019           type: string
3020         - name: tenant-context
3021           in: query
3022           description: This field will store the tenant context.
3023           required: false
3024           type: string
3025         - name: vserver-name
3026           in: query
3027           description: Name of vserver
3028           required: false
3029           type: string
3030         - name: vserver-name2
3031           in: query
3032           description: Alternative name of vserver
3033           required: false
3034           type: string
3035         - name: prov-status
3036           in: query
3037           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3038           required: false
3039           type: string
3040         - name: in-maint
3041           in: query
3042           required: false
3043           type: boolean
3044         - name: is-closed-loop-disabled
3045           in: query
3046           required: false
3047           type: boolean
3048         - name: interface-id
3049           in: query
3050           description: ID of interface
3051           required: false
3052           type: string
3053         - name: macaddr
3054           in: query
3055           description: MAC address for the interface
3056           required: false
3057           type: string
3058         - name: network-name
3059           in: query
3060           description: Name of the network
3061           required: false
3062           type: string
3063         - name: vf-vlan-filter
3064           in: query
3065           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
3066           required: false
3067           type: string
3068         - name: vf-mac-filter
3069           in: query
3070           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
3071           required: false
3072           type: string
3073         - name: vf-vlan-strip
3074           in: query
3075           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
3076           required: false
3077           type: boolean
3078         - name: neutron-network-id
3079           in: query
3080           description: Neutron network id of the interface
3081           required: false
3082           type: string
3083     put:
3084       tags:
3085         - CloudInfrastructure
3086       summary: create or update an existing sriov-vf
3087       description: |
3088         Create or update an existing sriov-vf.
3089         #
3090         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
3091       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3092       consumes:
3093         - application/json
3094         - application/xml
3095       produces:
3096         - application/json
3097         - application/xml
3098       responses:
3099         "default":
3100           description: Response codes found in [response codes](https://wiki.onap.org/).
3101       parameters:
3102         - name: cloud-owner
3103           in: path
3104           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3105           required: true
3106           type: string
3107           example: __CLOUD-OWNER__
3108         - name: cloud-region-id
3109           in: path
3110           description: Identifier used by the vendor for the region. Second part of composite key
3111           required: true
3112           type: string
3113           example: __CLOUD-REGION-ID__
3114         - name: tenant-id
3115           in: path
3116           description: Unique id relative to the cloud-region.
3117           required: true
3118           type: string
3119           example: __TENANT-ID__
3120         - name: vserver-id
3121           in: path
3122           description: Unique identifier for this vserver relative to its tenant
3123           required: true
3124           type: string
3125           example: __VSERVER-ID__
3126         - name: interface-name
3127           in: path
3128           description: Name given to the interface
3129           required: true
3130           type: string
3131           example: __INTERFACE-NAME__
3132         - name: pci-id
3133           in: path
3134           description: PCI ID used to identify the sriov-vf
3135           required: true
3136           type: string
3137           example: __PCI-ID__
3138         - name: body
3139           in: body
3140           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
3141           required: true
3142           schema:
3143             $ref: "#/definitions/sriov-vf"
3144     patch:
3145       tags:
3146         - CloudInfrastructure
3147       summary: update an existing sriov-vf
3148       description: |
3149         Update an existing sriov-vf
3150         #
3151         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3152         The PUT operation will entirely replace an existing object.
3153         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.
3154         #
3155         Other differences between PUT and PATCH are:
3156         #
3157         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3158         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3159         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3160       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3161       consumes:
3162         - application/json
3163         - application/xml
3164       produces:
3165         - application/json
3166         - application/xml
3167       responses:
3168         "default":
3169           description: Response codes found in [response codes](https://wiki.onap.org/).
3170       parameters:
3171         - name: cloud-owner
3172           in: path
3173           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3174           required: true
3175           type: string
3176           example: __CLOUD-OWNER__
3177         - name: cloud-region-id
3178           in: path
3179           description: Identifier used by the vendor for the region. Second part of composite key
3180           required: true
3181           type: string
3182           example: __CLOUD-REGION-ID__
3183         - name: tenant-id
3184           in: path
3185           description: Unique id relative to the cloud-region.
3186           required: true
3187           type: string
3188           example: __TENANT-ID__
3189         - name: vserver-id
3190           in: path
3191           description: Unique identifier for this vserver relative to its tenant
3192           required: true
3193           type: string
3194           example: __VSERVER-ID__
3195         - name: interface-name
3196           in: path
3197           description: Name given to the interface
3198           required: true
3199           type: string
3200           example: __INTERFACE-NAME__
3201         - name: pci-id
3202           in: path
3203           description: PCI ID used to identify the sriov-vf
3204           required: true
3205           type: string
3206           example: __PCI-ID__
3207         - name: body
3208           in: body
3209           description: sriov-vf object that needs to be created or updated.
3210           required: true
3211           schema:
3212             $ref: "#/patchDefinitions/sriov-vf"
3213     delete:
3214       tags:
3215         - CloudInfrastructure
3216       summary: delete an existing sriov-vf
3217       description: delete an existing sriov-vf
3218       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3219       consumes:
3220         - application/json
3221         - application/xml
3222       produces:
3223         - application/json
3224         - application/xml
3225       responses:
3226         "default":
3227           description: Response codes found in [response codes](https://wiki.onap.org/).
3228       parameters:
3229         - name: cloud-owner
3230           in: path
3231           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3232           required: true
3233           type: string
3234           example: __CLOUD-OWNER__
3235         - name: cloud-region-id
3236           in: path
3237           description: Identifier used by the vendor for the region. Second part of composite key
3238           required: true
3239           type: string
3240           example: __CLOUD-REGION-ID__
3241         - name: tenant-id
3242           in: path
3243           description: Unique id relative to the cloud-region.
3244           required: true
3245           type: string
3246           example: __TENANT-ID__
3247         - name: vserver-id
3248           in: path
3249           description: Unique identifier for this vserver relative to its tenant
3250           required: true
3251           type: string
3252           example: __VSERVER-ID__
3253         - name: interface-name
3254           in: path
3255           description: Name given to the interface
3256           required: true
3257           type: string
3258           example: __INTERFACE-NAME__
3259         - name: pci-id
3260           in: path
3261           description: PCI ID used to identify the sriov-vf
3262           required: true
3263           type: string
3264           example: __PCI-ID__
3265         - name: resource-version
3266           in: query
3267           description: resource-version for concurrency
3268           required: true
3269           type: string
3270   /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:
3271     get:
3272       tags:
3273         - CloudInfrastructure
3274       summary: returns sriov-vfs
3275       description: returns sriov-vfs
3276       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
3277       produces:
3278         - application/json
3279         - application/xml
3280       responses:
3281         "200":
3282           description: successful operation
3283           schema:
3284               $ref: "#/getDefinitions/sriov-vfs"
3285         "default":
3286           description: Response codes found in [response codes](https://wiki.onap.org/).
3287       parameters:
3288         - name: cloud-owner
3289           in: path
3290           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3291           required: true
3292           type: string
3293           example: __CLOUD-OWNER__
3294         - name: cloud-region-id
3295           in: path
3296           description: Identifier used by the vendor for the region. Second part of composite key
3297           required: true
3298           type: string
3299           example: __CLOUD-REGION-ID__
3300         - name: tenant-id
3301           in: path
3302           description: Unique id relative to the cloud-region.
3303           required: true
3304           type: string
3305           example: __TENANT-ID__
3306         - name: vserver-id
3307           in: path
3308           description: Unique identifier for this vserver relative to its tenant
3309           required: true
3310           type: string
3311           example: __VSERVER-ID__
3312         - name: interface-name
3313           in: path
3314           description: Name given to the interface
3315           required: true
3316           type: string
3317           example: __INTERFACE-NAME__
3318         - name: cloud-type
3319           in: query
3320           description: Type of the cloud (e.g., openstack)
3321           required: false
3322           type: string
3323         - name: owner-defined-type
3324           in: query
3325           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3326           required: false
3327           type: string
3328         - name: tenant-name
3329           in: query
3330           description: Readable name of tenant
3331           required: false
3332           type: string
3333         - name: tenant-context
3334           in: query
3335           description: This field will store the tenant context.
3336           required: false
3337           type: string
3338         - name: vserver-name
3339           in: query
3340           description: Name of vserver
3341           required: false
3342           type: string
3343         - name: vserver-name2
3344           in: query
3345           description: Alternative name of vserver
3346           required: false
3347           type: string
3348         - name: prov-status
3349           in: query
3350           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3351           required: false
3352           type: string
3353         - name: in-maint
3354           in: query
3355           required: false
3356           type: boolean
3357         - name: is-closed-loop-disabled
3358           in: query
3359           required: false
3360           type: boolean
3361         - name: interface-id
3362           in: query
3363           description: ID of interface
3364           required: false
3365           type: string
3366         - name: macaddr
3367           in: query
3368           description: MAC address for the interface
3369           required: false
3370           type: string
3371         - name: network-name
3372           in: query
3373           description: Name of the network
3374           required: false
3375           type: string
3376   /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:
3377     put:
3378       tags:
3379         - CloudInfrastructure
3380       summary: see node definition for valid relationships
3381       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
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: body
3423           in: body
3424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3425           required: true
3426           schema:
3427             $ref: "#/definitions/relationship"
3428     delete:
3429       tags:
3430         - CloudInfrastructure
3431       summary: delete an existing relationship
3432       description: delete an existing relationship
3433       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3434       consumes:
3435         - application/json
3436         - application/xml
3437       produces:
3438         - application/json
3439         - application/xml
3440       responses:
3441         "default":
3442           description: Response codes found in [response codes](https://wiki.onap.org/).
3443       parameters:
3444         - name: cloud-owner
3445           in: path
3446           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3447           required: true
3448           type: string
3449           example: __CLOUD-OWNER__
3450         - name: cloud-region-id
3451           in: path
3452           description: Identifier used by the vendor for the region. Second part of composite key
3453           required: true
3454           type: string
3455           example: __CLOUD-REGION-ID__
3456         - name: tenant-id
3457           in: path
3458           description: Unique id relative to the cloud-region.
3459           required: true
3460           type: string
3461           example: __TENANT-ID__
3462         - name: vserver-id
3463           in: path
3464           description: Unique identifier for this vserver relative to its tenant
3465           required: true
3466           type: string
3467           example: __VSERVER-ID__
3468         - name: interface-name
3469           in: path
3470           description: Name given to the interface
3471           required: true
3472           type: string
3473           example: __INTERFACE-NAME__
3474   /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:
3475     put:
3476       tags:
3477         - CloudInfrastructure
3478       summary: see node definition for valid relationships
3479       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3480       consumes:
3481         - application/json
3482         - application/xml
3483       produces:
3484         - application/json
3485         - application/xml
3486       responses:
3487         "default":
3488           description: Response codes found in [response codes](https://wiki.onap.org/).
3489       parameters:
3490         - name: cloud-owner
3491           in: path
3492           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3493           required: true
3494           type: string
3495           example: __CLOUD-OWNER__
3496         - name: cloud-region-id
3497           in: path
3498           description: Identifier used by the vendor for the region. Second part of composite key
3499           required: true
3500           type: string
3501           example: __CLOUD-REGION-ID__
3502         - name: tenant-id
3503           in: path
3504           description: Unique id relative to the cloud-region.
3505           required: true
3506           type: string
3507           example: __TENANT-ID__
3508         - name: vserver-id
3509           in: path
3510           description: Unique identifier for this vserver relative to its tenant
3511           required: true
3512           type: string
3513           example: __VSERVER-ID__
3514         - name: interface-name
3515           in: path
3516           description: Name given to the interface
3517           required: true
3518           type: string
3519           example: __INTERFACE-NAME__
3520         - name: l3-interface-ipv4-address
3521           in: path
3522           description: IP address
3523           required: true
3524           type: string
3525           example: __L3-INTERFACE-IPV4-ADDRESS__
3526         - name: body
3527           in: body
3528           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3529           required: true
3530           schema:
3531             $ref: "#/definitions/relationship"
3532     delete:
3533       tags:
3534         - CloudInfrastructure
3535       summary: delete an existing relationship
3536       description: delete an existing relationship
3537       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3538       consumes:
3539         - application/json
3540         - application/xml
3541       produces:
3542         - application/json
3543         - application/xml
3544       responses:
3545         "default":
3546           description: Response codes found in [response codes](https://wiki.onap.org/).
3547       parameters:
3548         - name: cloud-owner
3549           in: path
3550           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3551           required: true
3552           type: string
3553           example: __CLOUD-OWNER__
3554         - name: cloud-region-id
3555           in: path
3556           description: Identifier used by the vendor for the region. Second part of composite key
3557           required: true
3558           type: string
3559           example: __CLOUD-REGION-ID__
3560         - name: tenant-id
3561           in: path
3562           description: Unique id relative to the cloud-region.
3563           required: true
3564           type: string
3565           example: __TENANT-ID__
3566         - name: vserver-id
3567           in: path
3568           description: Unique identifier for this vserver relative to its tenant
3569           required: true
3570           type: string
3571           example: __VSERVER-ID__
3572         - name: interface-name
3573           in: path
3574           description: Name given to the interface
3575           required: true
3576           type: string
3577           example: __INTERFACE-NAME__
3578         - name: l3-interface-ipv4-address
3579           in: path
3580           description: IP address
3581           required: true
3582           type: string
3583           example: __L3-INTERFACE-IPV4-ADDRESS__
3584   /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}:
3585     get:
3586       tags:
3587         - CloudInfrastructure
3588       summary: returns l3-interface-ipv4-address-list
3589       description: returns l3-interface-ipv4-address-list
3590       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3591       produces:
3592         - application/json
3593         - application/xml
3594       responses:
3595         "200":
3596           description: successful operation
3597           schema:
3598               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3599         "default":
3600           description: Response codes found in [response codes](https://wiki.onap.org/).
3601       parameters:
3602         - name: cloud-owner
3603           in: path
3604           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3605           required: true
3606           type: string
3607           example: __CLOUD-OWNER__
3608         - name: cloud-region-id
3609           in: path
3610           description: Identifier used by the vendor for the region. Second part of composite key
3611           required: true
3612           type: string
3613           example: __CLOUD-REGION-ID__
3614         - name: tenant-id
3615           in: path
3616           description: Unique id relative to the cloud-region.
3617           required: true
3618           type: string
3619           example: __TENANT-ID__
3620         - name: vserver-id
3621           in: path
3622           description: Unique identifier for this vserver relative to its tenant
3623           required: true
3624           type: string
3625           example: __VSERVER-ID__
3626         - name: interface-name
3627           in: path
3628           description: Name given to the interface
3629           required: true
3630           type: string
3631           example: __INTERFACE-NAME__
3632         - name: l3-interface-ipv4-address
3633           in: path
3634           description: IP address
3635           required: true
3636           type: string
3637           example: __L3-INTERFACE-IPV4-ADDRESS__
3638         - name: cloud-type
3639           in: query
3640           description: Type of the cloud (e.g., openstack)
3641           required: false
3642           type: string
3643         - name: owner-defined-type
3644           in: query
3645           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3646           required: false
3647           type: string
3648         - name: tenant-name
3649           in: query
3650           description: Readable name of tenant
3651           required: false
3652           type: string
3653         - name: tenant-context
3654           in: query
3655           description: This field will store the tenant context.
3656           required: false
3657           type: string
3658         - name: vserver-name
3659           in: query
3660           description: Name of vserver
3661           required: false
3662           type: string
3663         - name: vserver-name2
3664           in: query
3665           description: Alternative name of vserver
3666           required: false
3667           type: string
3668         - name: prov-status
3669           in: query
3670           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3671           required: false
3672           type: string
3673         - name: in-maint
3674           in: query
3675           required: false
3676           type: boolean
3677         - name: is-closed-loop-disabled
3678           in: query
3679           required: false
3680           type: boolean
3681         - name: interface-id
3682           in: query
3683           description: ID of interface
3684           required: false
3685           type: string
3686         - name: macaddr
3687           in: query
3688           description: MAC address for the interface
3689           required: false
3690           type: string
3691         - name: network-name
3692           in: query
3693           description: Name of the network
3694           required: false
3695           type: string
3696         - name: vlan-id-inner
3697           in: query
3698           description: Inner VLAN tag
3699           required: false
3700           type: integer
3701           format: int64
3702         - name: neutron-network-id
3703           in: query
3704           description: Neutron network id of the interface that address belongs to
3705           required: false
3706           type: string
3707         - name: neutron-subnet-id
3708           in: query
3709           description: Neutron id of subnet that address belongs to
3710           required: false
3711           type: string
3712     put:
3713       tags:
3714         - CloudInfrastructure
3715       summary: create or update an existing l3-interface-ipv4-address-list
3716       description: |
3717         Create or update an existing l3-interface-ipv4-address-list.
3718         #
3719         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
3720       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3721       consumes:
3722         - application/json
3723         - application/xml
3724       produces:
3725         - application/json
3726         - application/xml
3727       responses:
3728         "default":
3729           description: Response codes found in [response codes](https://wiki.onap.org/).
3730       parameters:
3731         - name: cloud-owner
3732           in: path
3733           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3734           required: true
3735           type: string
3736           example: __CLOUD-OWNER__
3737         - name: cloud-region-id
3738           in: path
3739           description: Identifier used by the vendor for the region. Second part of composite key
3740           required: true
3741           type: string
3742           example: __CLOUD-REGION-ID__
3743         - name: tenant-id
3744           in: path
3745           description: Unique id relative to the cloud-region.
3746           required: true
3747           type: string
3748           example: __TENANT-ID__
3749         - name: vserver-id
3750           in: path
3751           description: Unique identifier for this vserver relative to its tenant
3752           required: true
3753           type: string
3754           example: __VSERVER-ID__
3755         - name: interface-name
3756           in: path
3757           description: Name given to the interface
3758           required: true
3759           type: string
3760           example: __INTERFACE-NAME__
3761         - name: l3-interface-ipv4-address
3762           in: path
3763           description: IP address
3764           required: true
3765           type: string
3766           example: __L3-INTERFACE-IPV4-ADDRESS__
3767         - name: body
3768           in: body
3769           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3770           required: true
3771           schema:
3772             $ref: "#/definitions/l3-interface-ipv4-address-list"
3773     patch:
3774       tags:
3775         - CloudInfrastructure
3776       summary: update an existing l3-interface-ipv4-address-list
3777       description: |
3778         Update an existing l3-interface-ipv4-address-list
3779         #
3780         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3781         The PUT operation will entirely replace an existing object.
3782         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.
3783         #
3784         Other differences between PUT and PATCH are:
3785         #
3786         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3787         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3788         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3789       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3790       consumes:
3791         - application/json
3792         - application/xml
3793       produces:
3794         - application/json
3795         - application/xml
3796       responses:
3797         "default":
3798           description: Response codes found in [response codes](https://wiki.onap.org/).
3799       parameters:
3800         - name: cloud-owner
3801           in: path
3802           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3803           required: true
3804           type: string
3805           example: __CLOUD-OWNER__
3806         - name: cloud-region-id
3807           in: path
3808           description: Identifier used by the vendor for the region. Second part of composite key
3809           required: true
3810           type: string
3811           example: __CLOUD-REGION-ID__
3812         - name: tenant-id
3813           in: path
3814           description: Unique id relative to the cloud-region.
3815           required: true
3816           type: string
3817           example: __TENANT-ID__
3818         - name: vserver-id
3819           in: path
3820           description: Unique identifier for this vserver relative to its tenant
3821           required: true
3822           type: string
3823           example: __VSERVER-ID__
3824         - name: interface-name
3825           in: path
3826           description: Name given to the interface
3827           required: true
3828           type: string
3829           example: __INTERFACE-NAME__
3830         - name: l3-interface-ipv4-address
3831           in: path
3832           description: IP address
3833           required: true
3834           type: string
3835           example: __L3-INTERFACE-IPV4-ADDRESS__
3836         - name: body
3837           in: body
3838           description: l3-interface-ipv4-address-list object that needs to be created or updated.
3839           required: true
3840           schema:
3841             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3842     delete:
3843       tags:
3844         - CloudInfrastructure
3845       summary: delete an existing l3-interface-ipv4-address-list
3846       description: delete an existing l3-interface-ipv4-address-list
3847       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3848       consumes:
3849         - application/json
3850         - application/xml
3851       produces:
3852         - application/json
3853         - application/xml
3854       responses:
3855         "default":
3856           description: Response codes found in [response codes](https://wiki.onap.org/).
3857       parameters:
3858         - name: cloud-owner
3859           in: path
3860           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3861           required: true
3862           type: string
3863           example: __CLOUD-OWNER__
3864         - name: cloud-region-id
3865           in: path
3866           description: Identifier used by the vendor for the region. Second part of composite key
3867           required: true
3868           type: string
3869           example: __CLOUD-REGION-ID__
3870         - name: tenant-id
3871           in: path
3872           description: Unique id relative to the cloud-region.
3873           required: true
3874           type: string
3875           example: __TENANT-ID__
3876         - name: vserver-id
3877           in: path
3878           description: Unique identifier for this vserver relative to its tenant
3879           required: true
3880           type: string
3881           example: __VSERVER-ID__
3882         - name: interface-name
3883           in: path
3884           description: Name given to the interface
3885           required: true
3886           type: string
3887           example: __INTERFACE-NAME__
3888         - name: l3-interface-ipv4-address
3889           in: path
3890           description: IP address
3891           required: true
3892           type: string
3893           example: __L3-INTERFACE-IPV4-ADDRESS__
3894         - name: resource-version
3895           in: query
3896           description: resource-version for concurrency
3897           required: true
3898           type: string
3899   /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:
3900     put:
3901       tags:
3902         - CloudInfrastructure
3903       summary: see node definition for valid relationships
3904       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3905       consumes:
3906         - application/json
3907         - application/xml
3908       produces:
3909         - application/json
3910         - application/xml
3911       responses:
3912         "default":
3913           description: Response codes found in [response codes](https://wiki.onap.org/).
3914       parameters:
3915         - name: cloud-owner
3916           in: path
3917           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3918           required: true
3919           type: string
3920           example: __CLOUD-OWNER__
3921         - name: cloud-region-id
3922           in: path
3923           description: Identifier used by the vendor for the region. Second part of composite key
3924           required: true
3925           type: string
3926           example: __CLOUD-REGION-ID__
3927         - name: tenant-id
3928           in: path
3929           description: Unique id relative to the cloud-region.
3930           required: true
3931           type: string
3932           example: __TENANT-ID__
3933         - name: vserver-id
3934           in: path
3935           description: Unique identifier for this vserver relative to its tenant
3936           required: true
3937           type: string
3938           example: __VSERVER-ID__
3939         - name: interface-name
3940           in: path
3941           description: Name given to the interface
3942           required: true
3943           type: string
3944           example: __INTERFACE-NAME__
3945         - name: l3-interface-ipv6-address
3946           in: path
3947           description: IP address
3948           required: true
3949           type: string
3950           example: __L3-INTERFACE-IPV6-ADDRESS__
3951         - name: body
3952           in: body
3953           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3954           required: true
3955           schema:
3956             $ref: "#/definitions/relationship"
3957     delete:
3958       tags:
3959         - CloudInfrastructure
3960       summary: delete an existing relationship
3961       description: delete an existing relationship
3962       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3963       consumes:
3964         - application/json
3965         - application/xml
3966       produces:
3967         - application/json
3968         - application/xml
3969       responses:
3970         "default":
3971           description: Response codes found in [response codes](https://wiki.onap.org/).
3972       parameters:
3973         - name: cloud-owner
3974           in: path
3975           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3976           required: true
3977           type: string
3978           example: __CLOUD-OWNER__
3979         - name: cloud-region-id
3980           in: path
3981           description: Identifier used by the vendor for the region. Second part of composite key
3982           required: true
3983           type: string
3984           example: __CLOUD-REGION-ID__
3985         - name: tenant-id
3986           in: path
3987           description: Unique id relative to the cloud-region.
3988           required: true
3989           type: string
3990           example: __TENANT-ID__
3991         - name: vserver-id
3992           in: path
3993           description: Unique identifier for this vserver relative to its tenant
3994           required: true
3995           type: string
3996           example: __VSERVER-ID__
3997         - name: interface-name
3998           in: path
3999           description: Name given to the interface
4000           required: true
4001           type: string
4002           example: __INTERFACE-NAME__
4003         - name: l3-interface-ipv6-address
4004           in: path
4005           description: IP address
4006           required: true
4007           type: string
4008           example: __L3-INTERFACE-IPV6-ADDRESS__
4009   /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}:
4010     get:
4011       tags:
4012         - CloudInfrastructure
4013       summary: returns l3-interface-ipv6-address-list
4014       description: returns l3-interface-ipv6-address-list
4015       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4016       produces:
4017         - application/json
4018         - application/xml
4019       responses:
4020         "200":
4021           description: successful operation
4022           schema:
4023               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
4024         "default":
4025           description: Response codes found in [response codes](https://wiki.onap.org/).
4026       parameters:
4027         - name: cloud-owner
4028           in: path
4029           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4030           required: true
4031           type: string
4032           example: __CLOUD-OWNER__
4033         - name: cloud-region-id
4034           in: path
4035           description: Identifier used by the vendor for the region. Second part of composite key
4036           required: true
4037           type: string
4038           example: __CLOUD-REGION-ID__
4039         - name: tenant-id
4040           in: path
4041           description: Unique id relative to the cloud-region.
4042           required: true
4043           type: string
4044           example: __TENANT-ID__
4045         - name: vserver-id
4046           in: path
4047           description: Unique identifier for this vserver relative to its tenant
4048           required: true
4049           type: string
4050           example: __VSERVER-ID__
4051         - name: interface-name
4052           in: path
4053           description: Name given to the interface
4054           required: true
4055           type: string
4056           example: __INTERFACE-NAME__
4057         - name: l3-interface-ipv6-address
4058           in: path
4059           description: IP address
4060           required: true
4061           type: string
4062           example: __L3-INTERFACE-IPV6-ADDRESS__
4063         - name: cloud-type
4064           in: query
4065           description: Type of the cloud (e.g., openstack)
4066           required: false
4067           type: string
4068         - name: owner-defined-type
4069           in: query
4070           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4071           required: false
4072           type: string
4073         - name: tenant-name
4074           in: query
4075           description: Readable name of tenant
4076           required: false
4077           type: string
4078         - name: tenant-context
4079           in: query
4080           description: This field will store the tenant context.
4081           required: false
4082           type: string
4083         - name: vserver-name
4084           in: query
4085           description: Name of vserver
4086           required: false
4087           type: string
4088         - name: vserver-name2
4089           in: query
4090           description: Alternative name of vserver
4091           required: false
4092           type: string
4093         - name: prov-status
4094           in: query
4095           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4096           required: false
4097           type: string
4098         - name: in-maint
4099           in: query
4100           required: false
4101           type: boolean
4102         - name: is-closed-loop-disabled
4103           in: query
4104           required: false
4105           type: boolean
4106         - name: interface-id
4107           in: query
4108           description: ID of interface
4109           required: false
4110           type: string
4111         - name: macaddr
4112           in: query
4113           description: MAC address for the interface
4114           required: false
4115           type: string
4116         - name: network-name
4117           in: query
4118           description: Name of the network
4119           required: false
4120           type: string
4121         - name: vlan-id-inner
4122           in: query
4123           description: Inner VLAN tag
4124           required: false
4125           type: integer
4126           format: int64
4127         - name: neutron-network-id
4128           in: query
4129           description: Neutron network id of the interface that address belongs to
4130           required: false
4131           type: string
4132         - name: neutron-subnet-id
4133           in: query
4134           description: Neutron id of subnet that address belongs to
4135           required: false
4136           type: string
4137     put:
4138       tags:
4139         - CloudInfrastructure
4140       summary: create or update an existing l3-interface-ipv6-address-list
4141       description: |
4142         Create or update an existing l3-interface-ipv6-address-list.
4143         #
4144         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
4145       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4146       consumes:
4147         - application/json
4148         - application/xml
4149       produces:
4150         - application/json
4151         - application/xml
4152       responses:
4153         "default":
4154           description: Response codes found in [response codes](https://wiki.onap.org/).
4155       parameters:
4156         - name: cloud-owner
4157           in: path
4158           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4159           required: true
4160           type: string
4161           example: __CLOUD-OWNER__
4162         - name: cloud-region-id
4163           in: path
4164           description: Identifier used by the vendor for the region. Second part of composite key
4165           required: true
4166           type: string
4167           example: __CLOUD-REGION-ID__
4168         - name: tenant-id
4169           in: path
4170           description: Unique id relative to the cloud-region.
4171           required: true
4172           type: string
4173           example: __TENANT-ID__
4174         - name: vserver-id
4175           in: path
4176           description: Unique identifier for this vserver relative to its tenant
4177           required: true
4178           type: string
4179           example: __VSERVER-ID__
4180         - name: interface-name
4181           in: path
4182           description: Name given to the interface
4183           required: true
4184           type: string
4185           example: __INTERFACE-NAME__
4186         - name: l3-interface-ipv6-address
4187           in: path
4188           description: IP address
4189           required: true
4190           type: string
4191           example: __L3-INTERFACE-IPV6-ADDRESS__
4192         - name: body
4193           in: body
4194           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
4195           required: true
4196           schema:
4197             $ref: "#/definitions/l3-interface-ipv6-address-list"
4198     patch:
4199       tags:
4200         - CloudInfrastructure
4201       summary: update an existing l3-interface-ipv6-address-list
4202       description: |
4203         Update an existing l3-interface-ipv6-address-list
4204         #
4205         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4206         The PUT operation will entirely replace an existing object.
4207         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.
4208         #
4209         Other differences between PUT and PATCH are:
4210         #
4211         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4212         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4213         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4214       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4215       consumes:
4216         - application/json
4217         - application/xml
4218       produces:
4219         - application/json
4220         - application/xml
4221       responses:
4222         "default":
4223           description: Response codes found in [response codes](https://wiki.onap.org/).
4224       parameters:
4225         - name: cloud-owner
4226           in: path
4227           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4228           required: true
4229           type: string
4230           example: __CLOUD-OWNER__
4231         - name: cloud-region-id
4232           in: path
4233           description: Identifier used by the vendor for the region. Second part of composite key
4234           required: true
4235           type: string
4236           example: __CLOUD-REGION-ID__
4237         - name: tenant-id
4238           in: path
4239           description: Unique id relative to the cloud-region.
4240           required: true
4241           type: string
4242           example: __TENANT-ID__
4243         - name: vserver-id
4244           in: path
4245           description: Unique identifier for this vserver relative to its tenant
4246           required: true
4247           type: string
4248           example: __VSERVER-ID__
4249         - name: interface-name
4250           in: path
4251           description: Name given to the interface
4252           required: true
4253           type: string
4254           example: __INTERFACE-NAME__
4255         - name: l3-interface-ipv6-address
4256           in: path
4257           description: IP address
4258           required: true
4259           type: string
4260           example: __L3-INTERFACE-IPV6-ADDRESS__
4261         - name: body
4262           in: body
4263           description: l3-interface-ipv6-address-list object that needs to be created or updated.
4264           required: true
4265           schema:
4266             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
4267     delete:
4268       tags:
4269         - CloudInfrastructure
4270       summary: delete an existing l3-interface-ipv6-address-list
4271       description: delete an existing l3-interface-ipv6-address-list
4272       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4273       consumes:
4274         - application/json
4275         - application/xml
4276       produces:
4277         - application/json
4278         - application/xml
4279       responses:
4280         "default":
4281           description: Response codes found in [response codes](https://wiki.onap.org/).
4282       parameters:
4283         - name: cloud-owner
4284           in: path
4285           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4286           required: true
4287           type: string
4288           example: __CLOUD-OWNER__
4289         - name: cloud-region-id
4290           in: path
4291           description: Identifier used by the vendor for the region. Second part of composite key
4292           required: true
4293           type: string
4294           example: __CLOUD-REGION-ID__
4295         - name: tenant-id
4296           in: path
4297           description: Unique id relative to the cloud-region.
4298           required: true
4299           type: string
4300           example: __TENANT-ID__
4301         - name: vserver-id
4302           in: path
4303           description: Unique identifier for this vserver relative to its tenant
4304           required: true
4305           type: string
4306           example: __VSERVER-ID__
4307         - name: interface-name
4308           in: path
4309           description: Name given to the interface
4310           required: true
4311           type: string
4312           example: __INTERFACE-NAME__
4313         - name: l3-interface-ipv6-address
4314           in: path
4315           description: IP address
4316           required: true
4317           type: string
4318           example: __L3-INTERFACE-IPV6-ADDRESS__
4319         - name: resource-version
4320           in: query
4321           description: resource-version for concurrency
4322           required: true
4323           type: string
4324   /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}:
4325     get:
4326       tags:
4327         - CloudInfrastructure
4328       summary: returns l-interface
4329       description: returns l-interface
4330       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4331       produces:
4332         - application/json
4333         - application/xml
4334       responses:
4335         "200":
4336           description: successful operation
4337           schema:
4338               $ref: "#/getDefinitions/l-interface"
4339         "default":
4340           description: Response codes found in [response codes](https://wiki.onap.org/).
4341       parameters:
4342         - name: cloud-owner
4343           in: path
4344           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4345           required: true
4346           type: string
4347           example: __CLOUD-OWNER__
4348         - name: cloud-region-id
4349           in: path
4350           description: Identifier used by the vendor for the region. Second part of composite key
4351           required: true
4352           type: string
4353           example: __CLOUD-REGION-ID__
4354         - name: tenant-id
4355           in: path
4356           description: Unique id relative to the cloud-region.
4357           required: true
4358           type: string
4359           example: __TENANT-ID__
4360         - name: vserver-id
4361           in: path
4362           description: Unique identifier for this vserver relative to its tenant
4363           required: true
4364           type: string
4365           example: __VSERVER-ID__
4366         - name: interface-name
4367           in: path
4368           description: Name given to the interface
4369           required: true
4370           type: string
4371           example: __INTERFACE-NAME__
4372         - name: cloud-type
4373           in: query
4374           description: Type of the cloud (e.g., openstack)
4375           required: false
4376           type: string
4377         - name: owner-defined-type
4378           in: query
4379           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4380           required: false
4381           type: string
4382         - name: tenant-name
4383           in: query
4384           description: Readable name of tenant
4385           required: false
4386           type: string
4387         - name: tenant-context
4388           in: query
4389           description: This field will store the tenant context.
4390           required: false
4391           type: string
4392         - name: vserver-name
4393           in: query
4394           description: Name of vserver
4395           required: false
4396           type: string
4397         - name: vserver-name2
4398           in: query
4399           description: Alternative name of vserver
4400           required: false
4401           type: string
4402         - name: prov-status
4403           in: query
4404           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4405           required: false
4406           type: string
4407         - name: in-maint
4408           in: query
4409           required: false
4410           type: boolean
4411         - name: is-closed-loop-disabled
4412           in: query
4413           required: false
4414           type: boolean
4415         - name: interface-id
4416           in: query
4417           description: ID of interface
4418           required: false
4419           type: string
4420         - name: macaddr
4421           in: query
4422           description: MAC address for the interface
4423           required: false
4424           type: string
4425         - name: network-name
4426           in: query
4427           description: Name of the network
4428           required: false
4429           type: string
4430     put:
4431       tags:
4432         - CloudInfrastructure
4433       summary: create or update an existing l-interface
4434       description: |
4435         Create or update an existing l-interface.
4436         #
4437         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
4438       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4439       consumes:
4440         - application/json
4441         - application/xml
4442       produces:
4443         - application/json
4444         - application/xml
4445       responses:
4446         "default":
4447           description: Response codes found in [response codes](https://wiki.onap.org/).
4448       parameters:
4449         - name: cloud-owner
4450           in: path
4451           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4452           required: true
4453           type: string
4454           example: __CLOUD-OWNER__
4455         - name: cloud-region-id
4456           in: path
4457           description: Identifier used by the vendor for the region. Second part of composite key
4458           required: true
4459           type: string
4460           example: __CLOUD-REGION-ID__
4461         - name: tenant-id
4462           in: path
4463           description: Unique id relative to the cloud-region.
4464           required: true
4465           type: string
4466           example: __TENANT-ID__
4467         - name: vserver-id
4468           in: path
4469           description: Unique identifier for this vserver relative to its tenant
4470           required: true
4471           type: string
4472           example: __VSERVER-ID__
4473         - name: interface-name
4474           in: path
4475           description: Name given to the interface
4476           required: true
4477           type: string
4478           example: __INTERFACE-NAME__
4479         - name: body
4480           in: body
4481           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
4482           required: true
4483           schema:
4484             $ref: "#/definitions/l-interface"
4485     patch:
4486       tags:
4487         - CloudInfrastructure
4488       summary: update an existing l-interface
4489       description: |
4490         Update an existing l-interface
4491         #
4492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4493         The PUT operation will entirely replace an existing object.
4494         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.
4495         #
4496         Other differences between PUT and PATCH are:
4497         #
4498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4501       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4502       consumes:
4503         - application/json
4504         - application/xml
4505       produces:
4506         - application/json
4507         - application/xml
4508       responses:
4509         "default":
4510           description: Response codes found in [response codes](https://wiki.onap.org/).
4511       parameters:
4512         - name: cloud-owner
4513           in: path
4514           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4515           required: true
4516           type: string
4517           example: __CLOUD-OWNER__
4518         - name: cloud-region-id
4519           in: path
4520           description: Identifier used by the vendor for the region. Second part of composite key
4521           required: true
4522           type: string
4523           example: __CLOUD-REGION-ID__
4524         - name: tenant-id
4525           in: path
4526           description: Unique id relative to the cloud-region.
4527           required: true
4528           type: string
4529           example: __TENANT-ID__
4530         - name: vserver-id
4531           in: path
4532           description: Unique identifier for this vserver relative to its tenant
4533           required: true
4534           type: string
4535           example: __VSERVER-ID__
4536         - name: interface-name
4537           in: path
4538           description: Name given to the interface
4539           required: true
4540           type: string
4541           example: __INTERFACE-NAME__
4542         - name: body
4543           in: body
4544           description: l-interface object that needs to be created or updated.
4545           required: true
4546           schema:
4547             $ref: "#/patchDefinitions/l-interface"
4548     delete:
4549       tags:
4550         - CloudInfrastructure
4551       summary: delete an existing l-interface
4552       description: delete an existing l-interface
4553       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4554       consumes:
4555         - application/json
4556         - application/xml
4557       produces:
4558         - application/json
4559         - application/xml
4560       responses:
4561         "default":
4562           description: Response codes found in [response codes](https://wiki.onap.org/).
4563       parameters:
4564         - name: cloud-owner
4565           in: path
4566           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4567           required: true
4568           type: string
4569           example: __CLOUD-OWNER__
4570         - name: cloud-region-id
4571           in: path
4572           description: Identifier used by the vendor for the region. Second part of composite key
4573           required: true
4574           type: string
4575           example: __CLOUD-REGION-ID__
4576         - name: tenant-id
4577           in: path
4578           description: Unique id relative to the cloud-region.
4579           required: true
4580           type: string
4581           example: __TENANT-ID__
4582         - name: vserver-id
4583           in: path
4584           description: Unique identifier for this vserver relative to its tenant
4585           required: true
4586           type: string
4587           example: __VSERVER-ID__
4588         - name: interface-name
4589           in: path
4590           description: Name given to the interface
4591           required: true
4592           type: string
4593           example: __INTERFACE-NAME__
4594         - name: resource-version
4595           in: query
4596           description: resource-version for concurrency
4597           required: true
4598           type: string
4599   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
4600     get:
4601       tags:
4602         - CloudInfrastructure
4603       summary: returns l-interfaces
4604       description: returns l-interfaces
4605       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
4606       produces:
4607         - application/json
4608         - application/xml
4609       responses:
4610         "200":
4611           description: successful operation
4612           schema:
4613               $ref: "#/getDefinitions/l-interfaces"
4614         "default":
4615           description: Response codes found in [response codes](https://wiki.onap.org/).
4616       parameters:
4617         - name: cloud-owner
4618           in: path
4619           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4620           required: true
4621           type: string
4622           example: __CLOUD-OWNER__
4623         - name: cloud-region-id
4624           in: path
4625           description: Identifier used by the vendor for the region. Second part of composite key
4626           required: true
4627           type: string
4628           example: __CLOUD-REGION-ID__
4629         - name: tenant-id
4630           in: path
4631           description: Unique id relative to the cloud-region.
4632           required: true
4633           type: string
4634           example: __TENANT-ID__
4635         - name: vserver-id
4636           in: path
4637           description: Unique identifier for this vserver relative to its tenant
4638           required: true
4639           type: string
4640           example: __VSERVER-ID__
4641         - name: cloud-type
4642           in: query
4643           description: Type of the cloud (e.g., openstack)
4644           required: false
4645           type: string
4646         - name: owner-defined-type
4647           in: query
4648           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4649           required: false
4650           type: string
4651         - name: tenant-name
4652           in: query
4653           description: Readable name of tenant
4654           required: false
4655           type: string
4656         - name: tenant-context
4657           in: query
4658           description: This field will store the tenant context.
4659           required: false
4660           type: string
4661         - name: vserver-name
4662           in: query
4663           description: Name of vserver
4664           required: false
4665           type: string
4666         - name: vserver-name2
4667           in: query
4668           description: Alternative name of vserver
4669           required: false
4670           type: string
4671         - name: prov-status
4672           in: query
4673           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4674           required: false
4675           type: string
4676         - name: in-maint
4677           in: query
4678           required: false
4679           type: boolean
4680         - name: is-closed-loop-disabled
4681           in: query
4682           required: false
4683           type: boolean
4684   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
4685     get:
4686       tags:
4687         - CloudInfrastructure
4688       summary: returns vserver
4689       description: returns vserver
4690       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4691       produces:
4692         - application/json
4693         - application/xml
4694       responses:
4695         "200":
4696           description: successful operation
4697           schema:
4698               $ref: "#/getDefinitions/vserver"
4699         "default":
4700           description: Response codes found in [response codes](https://wiki.onap.org/).
4701       parameters:
4702         - name: cloud-owner
4703           in: path
4704           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4705           required: true
4706           type: string
4707           example: __CLOUD-OWNER__
4708         - name: cloud-region-id
4709           in: path
4710           description: Identifier used by the vendor for the region. Second part of composite key
4711           required: true
4712           type: string
4713           example: __CLOUD-REGION-ID__
4714         - name: tenant-id
4715           in: path
4716           description: Unique id relative to the cloud-region.
4717           required: true
4718           type: string
4719           example: __TENANT-ID__
4720         - name: vserver-id
4721           in: path
4722           description: Unique identifier for this vserver relative to its tenant
4723           required: true
4724           type: string
4725           example: __VSERVER-ID__
4726         - name: cloud-type
4727           in: query
4728           description: Type of the cloud (e.g., openstack)
4729           required: false
4730           type: string
4731         - name: owner-defined-type
4732           in: query
4733           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4734           required: false
4735           type: string
4736         - name: tenant-name
4737           in: query
4738           description: Readable name of tenant
4739           required: false
4740           type: string
4741         - name: tenant-context
4742           in: query
4743           description: This field will store the tenant context.
4744           required: false
4745           type: string
4746         - name: vserver-name
4747           in: query
4748           description: Name of vserver
4749           required: false
4750           type: string
4751         - name: vserver-name2
4752           in: query
4753           description: Alternative name of vserver
4754           required: false
4755           type: string
4756         - name: prov-status
4757           in: query
4758           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4759           required: false
4760           type: string
4761         - name: in-maint
4762           in: query
4763           required: false
4764           type: boolean
4765         - name: is-closed-loop-disabled
4766           in: query
4767           required: false
4768           type: boolean
4769     put:
4770       tags:
4771         - CloudInfrastructure
4772       summary: create or update an existing vserver
4773       description: |
4774         Create or update an existing vserver.
4775         #
4776         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
4777       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4778       consumes:
4779         - application/json
4780         - application/xml
4781       produces:
4782         - application/json
4783         - application/xml
4784       responses:
4785         "default":
4786           description: Response codes found in [response codes](https://wiki.onap.org/).
4787       parameters:
4788         - name: cloud-owner
4789           in: path
4790           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4791           required: true
4792           type: string
4793           example: __CLOUD-OWNER__
4794         - name: cloud-region-id
4795           in: path
4796           description: Identifier used by the vendor for the region. Second part of composite key
4797           required: true
4798           type: string
4799           example: __CLOUD-REGION-ID__
4800         - name: tenant-id
4801           in: path
4802           description: Unique id relative to the cloud-region.
4803           required: true
4804           type: string
4805           example: __TENANT-ID__
4806         - name: vserver-id
4807           in: path
4808           description: Unique identifier for this vserver relative to its tenant
4809           required: true
4810           type: string
4811           example: __VSERVER-ID__
4812         - name: body
4813           in: body
4814           description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4815           required: true
4816           schema:
4817             $ref: "#/definitions/vserver"
4818     patch:
4819       tags:
4820         - CloudInfrastructure
4821       summary: update an existing vserver
4822       description: |
4823         Update an existing vserver
4824         #
4825         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4826         The PUT operation will entirely replace an existing object.
4827         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.
4828         #
4829         Other differences between PUT and PATCH are:
4830         #
4831         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4832         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4833         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4834       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4835       consumes:
4836         - application/json
4837         - application/xml
4838       produces:
4839         - application/json
4840         - application/xml
4841       responses:
4842         "default":
4843           description: Response codes found in [response codes](https://wiki.onap.org/).
4844       parameters:
4845         - name: cloud-owner
4846           in: path
4847           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4848           required: true
4849           type: string
4850           example: __CLOUD-OWNER__
4851         - name: cloud-region-id
4852           in: path
4853           description: Identifier used by the vendor for the region. Second part of composite key
4854           required: true
4855           type: string
4856           example: __CLOUD-REGION-ID__
4857         - name: tenant-id
4858           in: path
4859           description: Unique id relative to the cloud-region.
4860           required: true
4861           type: string
4862           example: __TENANT-ID__
4863         - name: vserver-id
4864           in: path
4865           description: Unique identifier for this vserver relative to its tenant
4866           required: true
4867           type: string
4868           example: __VSERVER-ID__
4869         - name: body
4870           in: body
4871           description: vserver object that needs to be created or updated.
4872           required: true
4873           schema:
4874             $ref: "#/patchDefinitions/vserver"
4875     delete:
4876       tags:
4877         - CloudInfrastructure
4878       summary: delete an existing vserver
4879       description: delete an existing vserver
4880       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4881       consumes:
4882         - application/json
4883         - application/xml
4884       produces:
4885         - application/json
4886         - application/xml
4887       responses:
4888         "default":
4889           description: Response codes found in [response codes](https://wiki.onap.org/).
4890       parameters:
4891         - name: cloud-owner
4892           in: path
4893           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4894           required: true
4895           type: string
4896           example: __CLOUD-OWNER__
4897         - name: cloud-region-id
4898           in: path
4899           description: Identifier used by the vendor for the region. Second part of composite key
4900           required: true
4901           type: string
4902           example: __CLOUD-REGION-ID__
4903         - name: tenant-id
4904           in: path
4905           description: Unique id relative to the cloud-region.
4906           required: true
4907           type: string
4908           example: __TENANT-ID__
4909         - name: vserver-id
4910           in: path
4911           description: Unique identifier for this vserver relative to its tenant
4912           required: true
4913           type: string
4914           example: __VSERVER-ID__
4915         - name: resource-version
4916           in: query
4917           description: resource-version for concurrency
4918           required: true
4919           type: string
4920   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4921     get:
4922       tags:
4923         - CloudInfrastructure
4924       summary: returns vservers
4925       description: returns vservers
4926       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4927       produces:
4928         - application/json
4929         - application/xml
4930       responses:
4931         "200":
4932           description: successful operation
4933           schema:
4934               $ref: "#/getDefinitions/vservers"
4935         "default":
4936           description: Response codes found in [response codes](https://wiki.onap.org/).
4937       parameters:
4938         - name: cloud-owner
4939           in: path
4940           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4941           required: true
4942           type: string
4943           example: __CLOUD-OWNER__
4944         - name: cloud-region-id
4945           in: path
4946           description: Identifier used by the vendor for the region. Second part of composite key
4947           required: true
4948           type: string
4949           example: __CLOUD-REGION-ID__
4950         - name: tenant-id
4951           in: path
4952           description: Unique id relative to the cloud-region.
4953           required: true
4954           type: string
4955           example: __TENANT-ID__
4956         - name: cloud-type
4957           in: query
4958           description: Type of the cloud (e.g., openstack)
4959           required: false
4960           type: string
4961         - name: owner-defined-type
4962           in: query
4963           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4964           required: false
4965           type: string
4966         - name: tenant-name
4967           in: query
4968           description: Readable name of tenant
4969           required: false
4970           type: string
4971         - name: tenant-context
4972           in: query
4973           description: This field will store the tenant context.
4974           required: false
4975           type: string
4976   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4977     put:
4978       tags:
4979         - CloudInfrastructure
4980       summary: see node definition for valid relationships
4981       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4982       consumes:
4983         - application/json
4984         - application/xml
4985       produces:
4986         - application/json
4987         - application/xml
4988       responses:
4989         "default":
4990           description: Response codes found in [response codes](https://wiki.onap.org/).
4991       parameters:
4992         - name: cloud-owner
4993           in: path
4994           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4995           required: true
4996           type: string
4997           example: __CLOUD-OWNER__
4998         - name: cloud-region-id
4999           in: path
5000           description: Identifier used by the vendor for the region. Second part of composite key
5001           required: true
5002           type: string
5003           example: __CLOUD-REGION-ID__
5004         - name: tenant-id
5005           in: path
5006           description: Unique id relative to the cloud-region.
5007           required: true
5008           type: string
5009           example: __TENANT-ID__
5010         - name: body
5011           in: body
5012           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5013           required: true
5014           schema:
5015             $ref: "#/definitions/relationship"
5016     delete:
5017       tags:
5018         - CloudInfrastructure
5019       summary: delete an existing relationship
5020       description: delete an existing relationship
5021       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
5022       consumes:
5023         - application/json
5024         - application/xml
5025       produces:
5026         - application/json
5027         - application/xml
5028       responses:
5029         "default":
5030           description: Response codes found in [response codes](https://wiki.onap.org/).
5031       parameters:
5032         - name: cloud-owner
5033           in: path
5034           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5035           required: true
5036           type: string
5037           example: __CLOUD-OWNER__
5038         - name: cloud-region-id
5039           in: path
5040           description: Identifier used by the vendor for the region. Second part of composite key
5041           required: true
5042           type: string
5043           example: __CLOUD-REGION-ID__
5044         - name: tenant-id
5045           in: path
5046           description: Unique id relative to the cloud-region.
5047           required: true
5048           type: string
5049           example: __TENANT-ID__
5050   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
5051     get:
5052       tags:
5053         - CloudInfrastructure
5054       summary: returns tenant
5055       description: returns tenant
5056       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5057       produces:
5058         - application/json
5059         - application/xml
5060       responses:
5061         "200":
5062           description: successful operation
5063           schema:
5064               $ref: "#/getDefinitions/tenant"
5065         "default":
5066           description: Response codes found in [response codes](https://wiki.onap.org/).
5067       parameters:
5068         - name: cloud-owner
5069           in: path
5070           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5071           required: true
5072           type: string
5073           example: __CLOUD-OWNER__
5074         - name: cloud-region-id
5075           in: path
5076           description: Identifier used by the vendor for the region. Second part of composite key
5077           required: true
5078           type: string
5079           example: __CLOUD-REGION-ID__
5080         - name: tenant-id
5081           in: path
5082           description: Unique id relative to the cloud-region.
5083           required: true
5084           type: string
5085           example: __TENANT-ID__
5086         - name: cloud-type
5087           in: query
5088           description: Type of the cloud (e.g., openstack)
5089           required: false
5090           type: string
5091         - name: owner-defined-type
5092           in: query
5093           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5094           required: false
5095           type: string
5096         - name: tenant-name
5097           in: query
5098           description: Readable name of tenant
5099           required: false
5100           type: string
5101         - name: tenant-context
5102           in: query
5103           description: This field will store the tenant context.
5104           required: false
5105           type: string
5106     put:
5107       tags:
5108         - CloudInfrastructure
5109       summary: create or update an existing tenant
5110       description: |
5111         Create or update an existing tenant.
5112         #
5113         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
5114       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5115       consumes:
5116         - application/json
5117         - application/xml
5118       produces:
5119         - application/json
5120         - application/xml
5121       responses:
5122         "default":
5123           description: Response codes found in [response codes](https://wiki.onap.org/).
5124       parameters:
5125         - name: cloud-owner
5126           in: path
5127           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5128           required: true
5129           type: string
5130           example: __CLOUD-OWNER__
5131         - name: cloud-region-id
5132           in: path
5133           description: Identifier used by the vendor for the region. Second part of composite key
5134           required: true
5135           type: string
5136           example: __CLOUD-REGION-ID__
5137         - name: tenant-id
5138           in: path
5139           description: Unique id relative to the cloud-region.
5140           required: true
5141           type: string
5142           example: __TENANT-ID__
5143         - name: body
5144           in: body
5145           description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5146           required: true
5147           schema:
5148             $ref: "#/definitions/tenant"
5149     patch:
5150       tags:
5151         - CloudInfrastructure
5152       summary: update an existing tenant
5153       description: |
5154         Update an existing tenant
5155         #
5156         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5157         The PUT operation will entirely replace an existing object.
5158         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.
5159         #
5160         Other differences between PUT and PATCH are:
5161         #
5162         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5163         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5164         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5165       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5166       consumes:
5167         - application/json
5168         - application/xml
5169       produces:
5170         - application/json
5171         - application/xml
5172       responses:
5173         "default":
5174           description: Response codes found in [response codes](https://wiki.onap.org/).
5175       parameters:
5176         - name: cloud-owner
5177           in: path
5178           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5179           required: true
5180           type: string
5181           example: __CLOUD-OWNER__
5182         - name: cloud-region-id
5183           in: path
5184           description: Identifier used by the vendor for the region. Second part of composite key
5185           required: true
5186           type: string
5187           example: __CLOUD-REGION-ID__
5188         - name: tenant-id
5189           in: path
5190           description: Unique id relative to the cloud-region.
5191           required: true
5192           type: string
5193           example: __TENANT-ID__
5194         - name: body
5195           in: body
5196           description: tenant object that needs to be created or updated.
5197           required: true
5198           schema:
5199             $ref: "#/patchDefinitions/tenant"
5200     delete:
5201       tags:
5202         - CloudInfrastructure
5203       summary: delete an existing tenant
5204       description: delete an existing tenant
5205       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5206       consumes:
5207         - application/json
5208         - application/xml
5209       produces:
5210         - application/json
5211         - application/xml
5212       responses:
5213         "default":
5214           description: Response codes found in [response codes](https://wiki.onap.org/).
5215       parameters:
5216         - name: cloud-owner
5217           in: path
5218           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5219           required: true
5220           type: string
5221           example: __CLOUD-OWNER__
5222         - name: cloud-region-id
5223           in: path
5224           description: Identifier used by the vendor for the region. Second part of composite key
5225           required: true
5226           type: string
5227           example: __CLOUD-REGION-ID__
5228         - name: tenant-id
5229           in: path
5230           description: Unique id relative to the cloud-region.
5231           required: true
5232           type: string
5233           example: __TENANT-ID__
5234         - name: resource-version
5235           in: query
5236           description: resource-version for concurrency
5237           required: true
5238           type: string
5239   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
5240     get:
5241       tags:
5242         - CloudInfrastructure
5243       summary: returns tenants
5244       description: returns tenants
5245       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
5246       produces:
5247         - application/json
5248         - application/xml
5249       responses:
5250         "200":
5251           description: successful operation
5252           schema:
5253               $ref: "#/getDefinitions/tenants"
5254         "default":
5255           description: Response codes found in [response codes](https://wiki.onap.org/).
5256       parameters:
5257         - name: cloud-owner
5258           in: path
5259           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5260           required: true
5261           type: string
5262           example: __CLOUD-OWNER__
5263         - name: cloud-region-id
5264           in: path
5265           description: Identifier used by the vendor for the region. Second part of composite key
5266           required: true
5267           type: string
5268           example: __CLOUD-REGION-ID__
5269         - name: cloud-type
5270           in: query
5271           description: Type of the cloud (e.g., openstack)
5272           required: false
5273           type: string
5274         - name: owner-defined-type
5275           in: query
5276           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5277           required: false
5278           type: string
5279   /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:
5280     put:
5281       tags:
5282         - CloudInfrastructure
5283       summary: see node definition for valid relationships
5284       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
5285       consumes:
5286         - application/json
5287         - application/xml
5288       produces:
5289         - application/json
5290         - application/xml
5291       responses:
5292         "default":
5293           description: Response codes found in [response codes](https://wiki.onap.org/).
5294       parameters:
5295         - name: cloud-owner
5296           in: path
5297           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5298           required: true
5299           type: string
5300           example: __CLOUD-OWNER__
5301         - name: cloud-region-id
5302           in: path
5303           description: Identifier used by the vendor for the region. Second part of composite key
5304           required: true
5305           type: string
5306           example: __CLOUD-REGION-ID__
5307         - name: flavor-id
5308           in: path
5309           description: Flavor id, expected to be unique across cloud-region.
5310           required: true
5311           type: string
5312           example: __FLAVOR-ID__
5313         - name: hpa-capability-id
5314           in: path
5315           description: UUID to uniquely identify a HPA capability
5316           required: true
5317           type: string
5318           example: __HPA-CAPABILITY-ID__
5319         - name: body
5320           in: body
5321           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
5322           required: true
5323           schema:
5324             $ref: "#/definitions/relationship"
5325     delete:
5326       tags:
5327         - CloudInfrastructure
5328       summary: delete an existing relationship
5329       description: delete an existing relationship
5330       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
5331       consumes:
5332         - application/json
5333         - application/xml
5334       produces:
5335         - application/json
5336         - application/xml
5337       responses:
5338         "default":
5339           description: Response codes found in [response codes](https://wiki.onap.org/).
5340       parameters:
5341         - name: cloud-owner
5342           in: path
5343           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5344           required: true
5345           type: string
5346           example: __CLOUD-OWNER__
5347         - name: cloud-region-id
5348           in: path
5349           description: Identifier used by the vendor for the region. Second part of composite key
5350           required: true
5351           type: string
5352           example: __CLOUD-REGION-ID__
5353         - name: flavor-id
5354           in: path
5355           description: Flavor id, expected to be unique across cloud-region.
5356           required: true
5357           type: string
5358           example: __FLAVOR-ID__
5359         - name: hpa-capability-id
5360           in: path
5361           description: UUID to uniquely identify a HPA capability
5362           required: true
5363           type: string
5364           example: __HPA-CAPABILITY-ID__
5365   /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/relationship-list/relationship:
5366     put:
5367       tags:
5368         - CloudInfrastructure
5369       summary: see node definition for valid relationships
5370       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
5371       consumes:
5372         - application/json
5373         - application/xml
5374       produces:
5375         - application/json
5376         - application/xml
5377       responses:
5378         "default":
5379           description: Response codes found in [response codes](https://wiki.onap.org/).
5380       parameters:
5381         - name: cloud-owner
5382           in: path
5383           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5384           required: true
5385           type: string
5386           example: __CLOUD-OWNER__
5387         - name: cloud-region-id
5388           in: path
5389           description: Identifier used by the vendor for the region. Second part of composite key
5390           required: true
5391           type: string
5392           example: __CLOUD-REGION-ID__
5393         - name: flavor-id
5394           in: path
5395           description: Flavor id, expected to be unique across cloud-region.
5396           required: true
5397           type: string
5398           example: __FLAVOR-ID__
5399         - name: hpa-capability-id
5400           in: path
5401           description: UUID to uniquely identify a HPA capability
5402           required: true
5403           type: string
5404           example: __HPA-CAPABILITY-ID__
5405         - name: body
5406           in: body
5407           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
5408           required: true
5409           schema:
5410             $ref: "#/definitions/relationship"
5411     delete:
5412       tags:
5413         - CloudInfrastructure
5414       summary: delete an existing relationship
5415       description: delete an existing relationship
5416       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
5417       consumes:
5418         - application/json
5419         - application/xml
5420       produces:
5421         - application/json
5422         - application/xml
5423       responses:
5424         "default":
5425           description: Response codes found in [response codes](https://wiki.onap.org/).
5426       parameters:
5427         - name: cloud-owner
5428           in: path
5429           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5430           required: true
5431           type: string
5432           example: __CLOUD-OWNER__
5433         - name: cloud-region-id
5434           in: path
5435           description: Identifier used by the vendor for the region. Second part of composite key
5436           required: true
5437           type: string
5438           example: __CLOUD-REGION-ID__
5439         - name: flavor-id
5440           in: path
5441           description: Flavor id, expected to be unique across cloud-region.
5442           required: true
5443           type: string
5444           example: __FLAVOR-ID__
5445         - name: hpa-capability-id
5446           in: path
5447           description: UUID to uniquely identify a HPA capability
5448           required: true
5449           type: string
5450           example: __HPA-CAPABILITY-ID__
5451   /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:
5452     get:
5453       tags:
5454         - CloudInfrastructure
5455       summary: returns hpa-feature-attributes
5456       description: returns hpa-feature-attributes
5457       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
5458       produces:
5459         - application/json
5460         - application/xml
5461       responses:
5462         "200":
5463           description: successful operation
5464           schema:
5465               $ref: "#/getDefinitions/hpa-feature-attributes"
5466         "default":
5467           description: Response codes found in [response codes](https://wiki.onap.org/).
5468       parameters:
5469         - name: cloud-owner
5470           in: path
5471           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5472           required: true
5473           type: string
5474           example: __CLOUD-OWNER__
5475         - name: cloud-region-id
5476           in: path
5477           description: Identifier used by the vendor for the region. Second part of composite key
5478           required: true
5479           type: string
5480           example: __CLOUD-REGION-ID__
5481         - name: flavor-id
5482           in: path
5483           description: Flavor id, expected to be unique across cloud-region.
5484           required: true
5485           type: string
5486           example: __FLAVOR-ID__
5487         - name: hpa-capability-id
5488           in: path
5489           description: UUID to uniquely identify a HPA capability
5490           required: true
5491           type: string
5492           example: __HPA-CAPABILITY-ID__
5493         - name: cloud-type
5494           in: query
5495           description: Type of the cloud (e.g., openstack)
5496           required: false
5497           type: string
5498         - name: owner-defined-type
5499           in: query
5500           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5501           required: false
5502           type: string
5503         - name: flavor-name
5504           in: query
5505           description: Cloud Region Flavor name
5506           required: false
5507           type: string
5508         - name: hpa-feature
5509           in: query
5510           description: Name of the HPACapability
5511           required: false
5512           type: string
5513         - name: hpa-hw-arch
5514           in: query
5515           description: Hardware architecture
5516           required: false
5517           type: string
5518   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
5519     get:
5520       tags:
5521         - CloudInfrastructure
5522       summary: returns hpa-capability
5523       description: returns hpa-capability
5524       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5525       produces:
5526         - application/json
5527         - application/xml
5528       responses:
5529         "200":
5530           description: successful operation
5531           schema:
5532               $ref: "#/getDefinitions/hpa-capability"
5533         "default":
5534           description: Response codes found in [response codes](https://wiki.onap.org/).
5535       parameters:
5536         - name: cloud-owner
5537           in: path
5538           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5539           required: true
5540           type: string
5541           example: __CLOUD-OWNER__
5542         - name: cloud-region-id
5543           in: path
5544           description: Identifier used by the vendor for the region. Second part of composite key
5545           required: true
5546           type: string
5547           example: __CLOUD-REGION-ID__
5548         - name: flavor-id
5549           in: path
5550           description: Flavor id, expected to be unique across cloud-region.
5551           required: true
5552           type: string
5553           example: __FLAVOR-ID__
5554         - name: hpa-capability-id
5555           in: path
5556           description: UUID to uniquely identify a HPA capability
5557           required: true
5558           type: string
5559           example: __HPA-CAPABILITY-ID__
5560         - name: cloud-type
5561           in: query
5562           description: Type of the cloud (e.g., openstack)
5563           required: false
5564           type: string
5565         - name: owner-defined-type
5566           in: query
5567           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5568           required: false
5569           type: string
5570         - name: flavor-name
5571           in: query
5572           description: Cloud Region Flavor name
5573           required: false
5574           type: string
5575         - name: hpa-feature
5576           in: query
5577           description: Name of the HPACapability
5578           required: false
5579           type: string
5580         - name: hpa-hw-arch
5581           in: query
5582           description: Hardware architecture
5583           required: false
5584           type: string
5585     put:
5586       tags:
5587         - CloudInfrastructure
5588       summary: create or update an existing hpa-capability
5589       description: |
5590         Create or update an existing hpa-capability.
5591         #
5592         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
5593       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5594       consumes:
5595         - application/json
5596         - application/xml
5597       produces:
5598         - application/json
5599         - application/xml
5600       responses:
5601         "default":
5602           description: Response codes found in [response codes](https://wiki.onap.org/).
5603       parameters:
5604         - name: cloud-owner
5605           in: path
5606           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5607           required: true
5608           type: string
5609           example: __CLOUD-OWNER__
5610         - name: cloud-region-id
5611           in: path
5612           description: Identifier used by the vendor for the region. Second part of composite key
5613           required: true
5614           type: string
5615           example: __CLOUD-REGION-ID__
5616         - name: flavor-id
5617           in: path
5618           description: Flavor id, expected to be unique across cloud-region.
5619           required: true
5620           type: string
5621           example: __FLAVOR-ID__
5622         - name: hpa-capability-id
5623           in: path
5624           description: UUID to uniquely identify a HPA capability
5625           required: true
5626           type: string
5627           example: __HPA-CAPABILITY-ID__
5628         - name: body
5629           in: body
5630           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
5631           required: true
5632           schema:
5633             $ref: "#/definitions/hpa-capability"
5634     patch:
5635       tags:
5636         - CloudInfrastructure
5637       summary: update an existing hpa-capability
5638       description: |
5639         Update an existing hpa-capability
5640         #
5641         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5642         The PUT operation will entirely replace an existing object.
5643         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.
5644         #
5645         Other differences between PUT and PATCH are:
5646         #
5647         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5648         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5649         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5650       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5651       consumes:
5652         - application/json
5653         - application/xml
5654       produces:
5655         - application/json
5656         - application/xml
5657       responses:
5658         "default":
5659           description: Response codes found in [response codes](https://wiki.onap.org/).
5660       parameters:
5661         - name: cloud-owner
5662           in: path
5663           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5664           required: true
5665           type: string
5666           example: __CLOUD-OWNER__
5667         - name: cloud-region-id
5668           in: path
5669           description: Identifier used by the vendor for the region. Second part of composite key
5670           required: true
5671           type: string
5672           example: __CLOUD-REGION-ID__
5673         - name: flavor-id
5674           in: path
5675           description: Flavor id, expected to be unique across cloud-region.
5676           required: true
5677           type: string
5678           example: __FLAVOR-ID__
5679         - name: hpa-capability-id
5680           in: path
5681           description: UUID to uniquely identify a HPA capability
5682           required: true
5683           type: string
5684           example: __HPA-CAPABILITY-ID__
5685         - name: body
5686           in: body
5687           description: hpa-capability object that needs to be created or updated.
5688           required: true
5689           schema:
5690             $ref: "#/patchDefinitions/hpa-capability"
5691     delete:
5692       tags:
5693         - CloudInfrastructure
5694       summary: delete an existing hpa-capability
5695       description: delete an existing hpa-capability
5696       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5697       consumes:
5698         - application/json
5699         - application/xml
5700       produces:
5701         - application/json
5702         - application/xml
5703       responses:
5704         "default":
5705           description: Response codes found in [response codes](https://wiki.onap.org/).
5706       parameters:
5707         - name: cloud-owner
5708           in: path
5709           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5710           required: true
5711           type: string
5712           example: __CLOUD-OWNER__
5713         - name: cloud-region-id
5714           in: path
5715           description: Identifier used by the vendor for the region. Second part of composite key
5716           required: true
5717           type: string
5718           example: __CLOUD-REGION-ID__
5719         - name: flavor-id
5720           in: path
5721           description: Flavor id, expected to be unique across cloud-region.
5722           required: true
5723           type: string
5724           example: __FLAVOR-ID__
5725         - name: hpa-capability-id
5726           in: path
5727           description: UUID to uniquely identify a HPA capability
5728           required: true
5729           type: string
5730           example: __HPA-CAPABILITY-ID__
5731         - name: resource-version
5732           in: query
5733           description: resource-version for concurrency
5734           required: true
5735           type: string
5736   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
5737     get:
5738       tags:
5739         - CloudInfrastructure
5740       summary: returns hpa-capabilities
5741       description: returns hpa-capabilities
5742       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
5743       produces:
5744         - application/json
5745         - application/xml
5746       responses:
5747         "200":
5748           description: successful operation
5749           schema:
5750               $ref: "#/getDefinitions/hpa-capabilities"
5751         "default":
5752           description: Response codes found in [response codes](https://wiki.onap.org/).
5753       parameters:
5754         - name: cloud-owner
5755           in: path
5756           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5757           required: true
5758           type: string
5759           example: __CLOUD-OWNER__
5760         - name: cloud-region-id
5761           in: path
5762           description: Identifier used by the vendor for the region. Second part of composite key
5763           required: true
5764           type: string
5765           example: __CLOUD-REGION-ID__
5766         - name: flavor-id
5767           in: path
5768           description: Flavor id, expected to be unique across cloud-region.
5769           required: true
5770           type: string
5771           example: __FLAVOR-ID__
5772         - name: cloud-type
5773           in: query
5774           description: Type of the cloud (e.g., openstack)
5775           required: false
5776           type: string
5777         - name: owner-defined-type
5778           in: query
5779           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5780           required: false
5781           type: string
5782         - name: flavor-name
5783           in: query
5784           description: Cloud Region Flavor name
5785           required: false
5786           type: string
5787   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5788     put:
5789       tags:
5790         - CloudInfrastructure
5791       summary: see node definition for valid relationships
5792       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5793       consumes:
5794         - application/json
5795         - application/xml
5796       produces:
5797         - application/json
5798         - application/xml
5799       responses:
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: flavor-id
5816           in: path
5817           description: Flavor id, expected to be unique across cloud-region.
5818           required: true
5819           type: string
5820           example: __FLAVOR-ID__
5821         - name: body
5822           in: body
5823           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5824           required: true
5825           schema:
5826             $ref: "#/definitions/relationship"
5827     delete:
5828       tags:
5829         - CloudInfrastructure
5830       summary: delete an existing relationship
5831       description: delete an existing relationship
5832       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5833       consumes:
5834         - application/json
5835         - application/xml
5836       produces:
5837         - application/json
5838         - application/xml
5839       responses:
5840         "default":
5841           description: Response codes found in [response codes](https://wiki.onap.org/).
5842       parameters:
5843         - name: cloud-owner
5844           in: path
5845           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5846           required: true
5847           type: string
5848           example: __CLOUD-OWNER__
5849         - name: cloud-region-id
5850           in: path
5851           description: Identifier used by the vendor for the region. Second part of composite key
5852           required: true
5853           type: string
5854           example: __CLOUD-REGION-ID__
5855         - name: flavor-id
5856           in: path
5857           description: Flavor id, expected to be unique across cloud-region.
5858           required: true
5859           type: string
5860           example: __FLAVOR-ID__
5861   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5862     get:
5863       tags:
5864         - CloudInfrastructure
5865       summary: returns flavor
5866       description: returns flavor
5867       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5868       produces:
5869         - application/json
5870         - application/xml
5871       responses:
5872         "200":
5873           description: successful operation
5874           schema:
5875               $ref: "#/getDefinitions/flavor"
5876         "default":
5877           description: Response codes found in [response codes](https://wiki.onap.org/).
5878       parameters:
5879         - name: cloud-owner
5880           in: path
5881           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5882           required: true
5883           type: string
5884           example: __CLOUD-OWNER__
5885         - name: cloud-region-id
5886           in: path
5887           description: Identifier used by the vendor for the region. Second part of composite key
5888           required: true
5889           type: string
5890           example: __CLOUD-REGION-ID__
5891         - name: flavor-id
5892           in: path
5893           description: Flavor id, expected to be unique across cloud-region.
5894           required: true
5895           type: string
5896           example: __FLAVOR-ID__
5897         - name: cloud-type
5898           in: query
5899           description: Type of the cloud (e.g., openstack)
5900           required: false
5901           type: string
5902         - name: owner-defined-type
5903           in: query
5904           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5905           required: false
5906           type: string
5907         - name: flavor-name
5908           in: query
5909           description: Cloud Region Flavor name
5910           required: false
5911           type: string
5912     put:
5913       tags:
5914         - CloudInfrastructure
5915       summary: create or update an existing flavor
5916       description: |
5917         Create or update an existing flavor.
5918         #
5919         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
5920       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
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: flavor-id
5944           in: path
5945           description: Flavor id, expected to be unique across cloud-region.
5946           required: true
5947           type: string
5948           example: __FLAVOR-ID__
5949         - name: body
5950           in: body
5951           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5952           required: true
5953           schema:
5954             $ref: "#/definitions/flavor"
5955     patch:
5956       tags:
5957         - CloudInfrastructure
5958       summary: update an existing flavor
5959       description: |
5960         Update an existing flavor
5961         #
5962         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5963         The PUT operation will entirely replace an existing object.
5964         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.
5965         #
5966         Other differences between PUT and PATCH are:
5967         #
5968         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5969         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5970         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5971       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5972       consumes:
5973         - application/json
5974         - application/xml
5975       produces:
5976         - application/json
5977         - application/xml
5978       responses:
5979         "default":
5980           description: Response codes found in [response codes](https://wiki.onap.org/).
5981       parameters:
5982         - name: cloud-owner
5983           in: path
5984           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5985           required: true
5986           type: string
5987           example: __CLOUD-OWNER__
5988         - name: cloud-region-id
5989           in: path
5990           description: Identifier used by the vendor for the region. Second part of composite key
5991           required: true
5992           type: string
5993           example: __CLOUD-REGION-ID__
5994         - name: flavor-id
5995           in: path
5996           description: Flavor id, expected to be unique across cloud-region.
5997           required: true
5998           type: string
5999           example: __FLAVOR-ID__
6000         - name: body
6001           in: body
6002           description: flavor object that needs to be created or updated.
6003           required: true
6004           schema:
6005             $ref: "#/patchDefinitions/flavor"
6006     delete:
6007       tags:
6008         - CloudInfrastructure
6009       summary: delete an existing flavor
6010       description: delete an existing flavor
6011       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
6012       consumes:
6013         - application/json
6014         - application/xml
6015       produces:
6016         - application/json
6017         - application/xml
6018       responses:
6019         "default":
6020           description: Response codes found in [response codes](https://wiki.onap.org/).
6021       parameters:
6022         - name: cloud-owner
6023           in: path
6024           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6025           required: true
6026           type: string
6027           example: __CLOUD-OWNER__
6028         - name: cloud-region-id
6029           in: path
6030           description: Identifier used by the vendor for the region. Second part of composite key
6031           required: true
6032           type: string
6033           example: __CLOUD-REGION-ID__
6034         - name: flavor-id
6035           in: path
6036           description: Flavor id, expected to be unique across cloud-region.
6037           required: true
6038           type: string
6039           example: __FLAVOR-ID__
6040         - name: resource-version
6041           in: query
6042           description: resource-version for concurrency
6043           required: true
6044           type: string
6045   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
6046     get:
6047       tags:
6048         - CloudInfrastructure
6049       summary: returns flavors
6050       description: returns flavors
6051       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
6052       produces:
6053         - application/json
6054         - application/xml
6055       responses:
6056         "200":
6057           description: successful operation
6058           schema:
6059               $ref: "#/getDefinitions/flavors"
6060         "default":
6061           description: Response codes found in [response codes](https://wiki.onap.org/).
6062       parameters:
6063         - name: cloud-owner
6064           in: path
6065           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6066           required: true
6067           type: string
6068           example: __CLOUD-OWNER__
6069         - name: cloud-region-id
6070           in: path
6071           description: Identifier used by the vendor for the region. Second part of composite key
6072           required: true
6073           type: string
6074           example: __CLOUD-REGION-ID__
6075         - name: cloud-type
6076           in: query
6077           description: Type of the cloud (e.g., openstack)
6078           required: false
6079           type: string
6080         - name: owner-defined-type
6081           in: query
6082           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6083           required: false
6084           type: string
6085   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
6086     put:
6087       tags:
6088         - CloudInfrastructure
6089       summary: see node definition for valid relationships
6090       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
6091       consumes:
6092         - application/json
6093         - application/xml
6094       produces:
6095         - application/json
6096         - application/xml
6097       responses:
6098         "default":
6099           description: Response codes found in [response codes](https://wiki.onap.org/).
6100       parameters:
6101         - name: cloud-owner
6102           in: path
6103           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6104           required: true
6105           type: string
6106           example: __CLOUD-OWNER__
6107         - name: cloud-region-id
6108           in: path
6109           description: Identifier used by the vendor for the region. Second part of composite key
6110           required: true
6111           type: string
6112           example: __CLOUD-REGION-ID__
6113         - name: group-id
6114           in: path
6115           description: Group id, expected to be unique across cloud-region.
6116           required: true
6117           type: string
6118           example: __GROUP-ID__
6119         - name: body
6120           in: body
6121           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
6122           required: true
6123           schema:
6124             $ref: "#/definitions/relationship"
6125     delete:
6126       tags:
6127         - CloudInfrastructure
6128       summary: delete an existing relationship
6129       description: delete an existing relationship
6130       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
6131       consumes:
6132         - application/json
6133         - application/xml
6134       produces:
6135         - application/json
6136         - application/xml
6137       responses:
6138         "default":
6139           description: Response codes found in [response codes](https://wiki.onap.org/).
6140       parameters:
6141         - name: cloud-owner
6142           in: path
6143           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6144           required: true
6145           type: string
6146           example: __CLOUD-OWNER__
6147         - name: cloud-region-id
6148           in: path
6149           description: Identifier used by the vendor for the region. Second part of composite key
6150           required: true
6151           type: string
6152           example: __CLOUD-REGION-ID__
6153         - name: group-id
6154           in: path
6155           description: Group id, expected to be unique across cloud-region.
6156           required: true
6157           type: string
6158           example: __GROUP-ID__
6159   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
6160     get:
6161       tags:
6162         - CloudInfrastructure
6163       summary: returns group-assignment
6164       description: returns group-assignment
6165       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6166       produces:
6167         - application/json
6168         - application/xml
6169       responses:
6170         "200":
6171           description: successful operation
6172           schema:
6173               $ref: "#/getDefinitions/group-assignment"
6174         "default":
6175           description: Response codes found in [response codes](https://wiki.onap.org/).
6176       parameters:
6177         - name: cloud-owner
6178           in: path
6179           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6180           required: true
6181           type: string
6182           example: __CLOUD-OWNER__
6183         - name: cloud-region-id
6184           in: path
6185           description: Identifier used by the vendor for the region. Second part of composite key
6186           required: true
6187           type: string
6188           example: __CLOUD-REGION-ID__
6189         - name: group-id
6190           in: path
6191           description: Group id, expected to be unique across cloud-region.
6192           required: true
6193           type: string
6194           example: __GROUP-ID__
6195         - name: cloud-type
6196           in: query
6197           description: Type of the cloud (e.g., openstack)
6198           required: false
6199           type: string
6200         - name: owner-defined-type
6201           in: query
6202           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6203           required: false
6204           type: string
6205         - name: group-type
6206           in: query
6207           description: Group type - the type of group this instance refers to
6208           required: false
6209           type: string
6210         - name: group-name
6211           in: query
6212           description: Group name - name assigned to the group
6213           required: false
6214           type: string
6215     put:
6216       tags:
6217         - CloudInfrastructure
6218       summary: create or update an existing group-assignment
6219       description: |
6220         Create or update an existing group-assignment.
6221         #
6222         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
6223       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6224       consumes:
6225         - application/json
6226         - application/xml
6227       produces:
6228         - application/json
6229         - application/xml
6230       responses:
6231         "default":
6232           description: Response codes found in [response codes](https://wiki.onap.org/).
6233       parameters:
6234         - name: cloud-owner
6235           in: path
6236           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6237           required: true
6238           type: string
6239           example: __CLOUD-OWNER__
6240         - name: cloud-region-id
6241           in: path
6242           description: Identifier used by the vendor for the region. Second part of composite key
6243           required: true
6244           type: string
6245           example: __CLOUD-REGION-ID__
6246         - name: group-id
6247           in: path
6248           description: Group id, expected to be unique across cloud-region.
6249           required: true
6250           type: string
6251           example: __GROUP-ID__
6252         - name: body
6253           in: body
6254           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
6255           required: true
6256           schema:
6257             $ref: "#/definitions/group-assignment"
6258     patch:
6259       tags:
6260         - CloudInfrastructure
6261       summary: update an existing group-assignment
6262       description: |
6263         Update an existing group-assignment
6264         #
6265         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6266         The PUT operation will entirely replace an existing object.
6267         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.
6268         #
6269         Other differences between PUT and PATCH are:
6270         #
6271         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6272         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6273         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6274       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6275       consumes:
6276         - application/json
6277         - application/xml
6278       produces:
6279         - application/json
6280         - application/xml
6281       responses:
6282         "default":
6283           description: Response codes found in [response codes](https://wiki.onap.org/).
6284       parameters:
6285         - name: cloud-owner
6286           in: path
6287           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6288           required: true
6289           type: string
6290           example: __CLOUD-OWNER__
6291         - name: cloud-region-id
6292           in: path
6293           description: Identifier used by the vendor for the region. Second part of composite key
6294           required: true
6295           type: string
6296           example: __CLOUD-REGION-ID__
6297         - name: group-id
6298           in: path
6299           description: Group id, expected to be unique across cloud-region.
6300           required: true
6301           type: string
6302           example: __GROUP-ID__
6303         - name: body
6304           in: body
6305           description: group-assignment object that needs to be created or updated.
6306           required: true
6307           schema:
6308             $ref: "#/patchDefinitions/group-assignment"
6309     delete:
6310       tags:
6311         - CloudInfrastructure
6312       summary: delete an existing group-assignment
6313       description: delete an existing group-assignment
6314       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
6315       consumes:
6316         - application/json
6317         - application/xml
6318       produces:
6319         - application/json
6320         - application/xml
6321       responses:
6322         "default":
6323           description: Response codes found in [response codes](https://wiki.onap.org/).
6324       parameters:
6325         - name: cloud-owner
6326           in: path
6327           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6328           required: true
6329           type: string
6330           example: __CLOUD-OWNER__
6331         - name: cloud-region-id
6332           in: path
6333           description: Identifier used by the vendor for the region. Second part of composite key
6334           required: true
6335           type: string
6336           example: __CLOUD-REGION-ID__
6337         - name: group-id
6338           in: path
6339           description: Group id, expected to be unique across cloud-region.
6340           required: true
6341           type: string
6342           example: __GROUP-ID__
6343         - name: resource-version
6344           in: query
6345           description: resource-version for concurrency
6346           required: true
6347           type: string
6348   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
6349     get:
6350       tags:
6351         - CloudInfrastructure
6352       summary: returns group-assignments
6353       description: returns group-assignments
6354       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
6355       produces:
6356         - application/json
6357         - application/xml
6358       responses:
6359         "200":
6360           description: successful operation
6361           schema:
6362               $ref: "#/getDefinitions/group-assignments"
6363         "default":
6364           description: Response codes found in [response codes](https://wiki.onap.org/).
6365       parameters:
6366         - name: cloud-owner
6367           in: path
6368           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6369           required: true
6370           type: string
6371           example: __CLOUD-OWNER__
6372         - name: cloud-region-id
6373           in: path
6374           description: Identifier used by the vendor for the region. Second part of composite key
6375           required: true
6376           type: string
6377           example: __CLOUD-REGION-ID__
6378         - name: cloud-type
6379           in: query
6380           description: Type of the cloud (e.g., openstack)
6381           required: false
6382           type: string
6383         - name: owner-defined-type
6384           in: query
6385           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6386           required: false
6387           type: string
6388   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
6389     put:
6390       tags:
6391         - CloudInfrastructure
6392       summary: see node definition for valid relationships
6393       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
6394       consumes:
6395         - application/json
6396         - application/xml
6397       produces:
6398         - application/json
6399         - application/xml
6400       responses:
6401         "default":
6402           description: Response codes found in [response codes](https://wiki.onap.org/).
6403       parameters:
6404         - name: cloud-owner
6405           in: path
6406           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6407           required: true
6408           type: string
6409           example: __CLOUD-OWNER__
6410         - name: cloud-region-id
6411           in: path
6412           description: Identifier used by the vendor for the region. Second part of composite key
6413           required: true
6414           type: string
6415           example: __CLOUD-REGION-ID__
6416         - name: snapshot-id
6417           in: path
6418           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6419           required: true
6420           type: string
6421           example: __SNAPSHOT-ID__
6422         - name: body
6423           in: body
6424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
6425           required: true
6426           schema:
6427             $ref: "#/definitions/relationship"
6428     delete:
6429       tags:
6430         - CloudInfrastructure
6431       summary: delete an existing relationship
6432       description: delete an existing relationship
6433       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
6434       consumes:
6435         - application/json
6436         - application/xml
6437       produces:
6438         - application/json
6439         - application/xml
6440       responses:
6441         "default":
6442           description: Response codes found in [response codes](https://wiki.onap.org/).
6443       parameters:
6444         - name: cloud-owner
6445           in: path
6446           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6447           required: true
6448           type: string
6449           example: __CLOUD-OWNER__
6450         - name: cloud-region-id
6451           in: path
6452           description: Identifier used by the vendor for the region. Second part of composite key
6453           required: true
6454           type: string
6455           example: __CLOUD-REGION-ID__
6456         - name: snapshot-id
6457           in: path
6458           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6459           required: true
6460           type: string
6461           example: __SNAPSHOT-ID__
6462   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
6463     get:
6464       tags:
6465         - CloudInfrastructure
6466       summary: returns snapshot
6467       description: returns snapshot
6468       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6469       produces:
6470         - application/json
6471         - application/xml
6472       responses:
6473         "200":
6474           description: successful operation
6475           schema:
6476               $ref: "#/getDefinitions/snapshot"
6477         "default":
6478           description: Response codes found in [response codes](https://wiki.onap.org/).
6479       parameters:
6480         - name: cloud-owner
6481           in: path
6482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6483           required: true
6484           type: string
6485           example: __CLOUD-OWNER__
6486         - name: cloud-region-id
6487           in: path
6488           description: Identifier used by the vendor for the region. Second part of composite key
6489           required: true
6490           type: string
6491           example: __CLOUD-REGION-ID__
6492         - name: snapshot-id
6493           in: path
6494           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6495           required: true
6496           type: string
6497           example: __SNAPSHOT-ID__
6498         - name: cloud-type
6499           in: query
6500           description: Type of the cloud (e.g., openstack)
6501           required: false
6502           type: string
6503         - name: owner-defined-type
6504           in: query
6505           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6506           required: false
6507           type: string
6508         - name: snapshot-name
6509           in: query
6510           description: Snapshot name
6511           required: false
6512           type: string
6513         - name: application
6514           in: query
6515           description: The application that the image instantiates.
6516           required: false
6517           type: string
6518         - name: application-vendor
6519           in: query
6520           description: The vendor of the application.
6521           required: false
6522           type: string
6523         - name: application-version
6524           in: query
6525           description: The version of the application.
6526           required: false
6527           type: string
6528         - name: prev-snapshot-id
6529           in: query
6530           description: This field contains the UUID of the previous snapshot (if any).
6531           required: false
6532           type: string
6533     put:
6534       tags:
6535         - CloudInfrastructure
6536       summary: create or update an existing snapshot
6537       description: |
6538         Create or update an existing snapshot.
6539         #
6540         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
6541       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6542       consumes:
6543         - application/json
6544         - application/xml
6545       produces:
6546         - application/json
6547         - application/xml
6548       responses:
6549         "default":
6550           description: Response codes found in [response codes](https://wiki.onap.org/).
6551       parameters:
6552         - name: cloud-owner
6553           in: path
6554           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6555           required: true
6556           type: string
6557           example: __CLOUD-OWNER__
6558         - name: cloud-region-id
6559           in: path
6560           description: Identifier used by the vendor for the region. Second part of composite key
6561           required: true
6562           type: string
6563           example: __CLOUD-REGION-ID__
6564         - name: snapshot-id
6565           in: path
6566           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6567           required: true
6568           type: string
6569           example: __SNAPSHOT-ID__
6570         - name: body
6571           in: body
6572           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
6573           required: true
6574           schema:
6575             $ref: "#/definitions/snapshot"
6576     patch:
6577       tags:
6578         - CloudInfrastructure
6579       summary: update an existing snapshot
6580       description: |
6581         Update an existing snapshot
6582         #
6583         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6584         The PUT operation will entirely replace an existing object.
6585         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.
6586         #
6587         Other differences between PUT and PATCH are:
6588         #
6589         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6590         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6591         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6592       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6593       consumes:
6594         - application/json
6595         - application/xml
6596       produces:
6597         - application/json
6598         - application/xml
6599       responses:
6600         "default":
6601           description: Response codes found in [response codes](https://wiki.onap.org/).
6602       parameters:
6603         - name: cloud-owner
6604           in: path
6605           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6606           required: true
6607           type: string
6608           example: __CLOUD-OWNER__
6609         - name: cloud-region-id
6610           in: path
6611           description: Identifier used by the vendor for the region. Second part of composite key
6612           required: true
6613           type: string
6614           example: __CLOUD-REGION-ID__
6615         - name: snapshot-id
6616           in: path
6617           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6618           required: true
6619           type: string
6620           example: __SNAPSHOT-ID__
6621         - name: body
6622           in: body
6623           description: snapshot object that needs to be created or updated.
6624           required: true
6625           schema:
6626             $ref: "#/patchDefinitions/snapshot"
6627     delete:
6628       tags:
6629         - CloudInfrastructure
6630       summary: delete an existing snapshot
6631       description: delete an existing snapshot
6632       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6633       consumes:
6634         - application/json
6635         - application/xml
6636       produces:
6637         - application/json
6638         - application/xml
6639       responses:
6640         "default":
6641           description: Response codes found in [response codes](https://wiki.onap.org/).
6642       parameters:
6643         - name: cloud-owner
6644           in: path
6645           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6646           required: true
6647           type: string
6648           example: __CLOUD-OWNER__
6649         - name: cloud-region-id
6650           in: path
6651           description: Identifier used by the vendor for the region. Second part of composite key
6652           required: true
6653           type: string
6654           example: __CLOUD-REGION-ID__
6655         - name: snapshot-id
6656           in: path
6657           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6658           required: true
6659           type: string
6660           example: __SNAPSHOT-ID__
6661         - name: resource-version
6662           in: query
6663           description: resource-version for concurrency
6664           required: true
6665           type: string
6666   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
6667     get:
6668       tags:
6669         - CloudInfrastructure
6670       summary: returns snapshots
6671       description: returns snapshots
6672       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
6673       produces:
6674         - application/json
6675         - application/xml
6676       responses:
6677         "200":
6678           description: successful operation
6679           schema:
6680               $ref: "#/getDefinitions/snapshots"
6681         "default":
6682           description: Response codes found in [response codes](https://wiki.onap.org/).
6683       parameters:
6684         - name: cloud-owner
6685           in: path
6686           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6687           required: true
6688           type: string
6689           example: __CLOUD-OWNER__
6690         - name: cloud-region-id
6691           in: path
6692           description: Identifier used by the vendor for the region. Second part of composite key
6693           required: true
6694           type: string
6695           example: __CLOUD-REGION-ID__
6696         - name: cloud-type
6697           in: query
6698           description: Type of the cloud (e.g., openstack)
6699           required: false
6700           type: string
6701         - name: owner-defined-type
6702           in: query
6703           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6704           required: false
6705           type: string
6706   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6707     put:
6708       tags:
6709         - CloudInfrastructure
6710       summary: see node definition for valid relationships
6711       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
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: image-id
6735           in: path
6736           description: Image id, expected to be unique across cloud region
6737           required: true
6738           type: string
6739           example: __IMAGE-ID__
6740         - name: body
6741           in: body
6742           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6743           required: true
6744           schema:
6745             $ref: "#/definitions/relationship"
6746     delete:
6747       tags:
6748         - CloudInfrastructure
6749       summary: delete an existing relationship
6750       description: delete an existing relationship
6751       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
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: image-id
6775           in: path
6776           description: Image id, expected to be unique across cloud region
6777           required: true
6778           type: string
6779           example: __IMAGE-ID__
6780   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6781     get:
6782       tags:
6783         - CloudInfrastructure
6784       summary: returns metadatum
6785       description: returns metadatum
6786       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6787       produces:
6788         - application/json
6789         - application/xml
6790       responses:
6791         "200":
6792           description: successful operation
6793           schema:
6794               $ref: "#/getDefinitions/metadatum"
6795         "default":
6796           description: Response codes found in [response codes](https://wiki.onap.org/).
6797       parameters:
6798         - name: cloud-owner
6799           in: path
6800           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6801           required: true
6802           type: string
6803           example: __CLOUD-OWNER__
6804         - name: cloud-region-id
6805           in: path
6806           description: Identifier used by the vendor for the region. Second part of composite key
6807           required: true
6808           type: string
6809           example: __CLOUD-REGION-ID__
6810         - name: image-id
6811           in: path
6812           description: Image id, expected to be unique across cloud region
6813           required: true
6814           type: string
6815           example: __IMAGE-ID__
6816         - name: metaname
6817           in: path
6818           required: true
6819           type: string
6820           example: __METANAME__
6821         - name: cloud-type
6822           in: query
6823           description: Type of the cloud (e.g., openstack)
6824           required: false
6825           type: string
6826         - name: owner-defined-type
6827           in: query
6828           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6829           required: false
6830           type: string
6831         - name: image-name
6832           in: query
6833           description: Image name
6834           required: false
6835           type: string
6836         - name: application
6837           in: query
6838           description: The application that the image instantiates.
6839           required: false
6840           type: string
6841         - name: application-vendor
6842           in: query
6843           description: The vendor of the application.
6844           required: false
6845           type: string
6846         - name: application-version
6847           in: query
6848           description: The version of the application.
6849           required: false
6850           type: string
6851     put:
6852       tags:
6853         - CloudInfrastructure
6854       summary: create or update an existing metadatum
6855       description: |
6856         Create or update an existing metadatum.
6857         #
6858         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
6859       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6860       consumes:
6861         - application/json
6862         - application/xml
6863       produces:
6864         - application/json
6865         - application/xml
6866       responses:
6867         "default":
6868           description: Response codes found in [response codes](https://wiki.onap.org/).
6869       parameters:
6870         - name: cloud-owner
6871           in: path
6872           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6873           required: true
6874           type: string
6875           example: __CLOUD-OWNER__
6876         - name: cloud-region-id
6877           in: path
6878           description: Identifier used by the vendor for the region. Second part of composite key
6879           required: true
6880           type: string
6881           example: __CLOUD-REGION-ID__
6882         - name: image-id
6883           in: path
6884           description: Image id, expected to be unique across cloud region
6885           required: true
6886           type: string
6887           example: __IMAGE-ID__
6888         - name: metaname
6889           in: path
6890           required: true
6891           type: string
6892           example: __METANAME__
6893         - name: body
6894           in: body
6895           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6896           required: true
6897           schema:
6898             $ref: "#/definitions/metadatum"
6899     patch:
6900       tags:
6901         - CloudInfrastructure
6902       summary: update an existing metadatum
6903       description: |
6904         Update an existing metadatum
6905         #
6906         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6907         The PUT operation will entirely replace an existing object.
6908         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.
6909         #
6910         Other differences between PUT and PATCH are:
6911         #
6912         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6913         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6914         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6915       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6916       consumes:
6917         - application/json
6918         - application/xml
6919       produces:
6920         - application/json
6921         - application/xml
6922       responses:
6923         "default":
6924           description: Response codes found in [response codes](https://wiki.onap.org/).
6925       parameters:
6926         - name: cloud-owner
6927           in: path
6928           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6929           required: true
6930           type: string
6931           example: __CLOUD-OWNER__
6932         - name: cloud-region-id
6933           in: path
6934           description: Identifier used by the vendor for the region. Second part of composite key
6935           required: true
6936           type: string
6937           example: __CLOUD-REGION-ID__
6938         - name: image-id
6939           in: path
6940           description: Image id, expected to be unique across cloud region
6941           required: true
6942           type: string
6943           example: __IMAGE-ID__
6944         - name: metaname
6945           in: path
6946           required: true
6947           type: string
6948           example: __METANAME__
6949         - name: body
6950           in: body
6951           description: metadatum object that needs to be created or updated.
6952           required: true
6953           schema:
6954             $ref: "#/patchDefinitions/metadatum"
6955     delete:
6956       tags:
6957         - CloudInfrastructure
6958       summary: delete an existing metadatum
6959       description: delete an existing metadatum
6960       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6961       consumes:
6962         - application/json
6963         - application/xml
6964       produces:
6965         - application/json
6966         - application/xml
6967       responses:
6968         "default":
6969           description: Response codes found in [response codes](https://wiki.onap.org/).
6970       parameters:
6971         - name: cloud-owner
6972           in: path
6973           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6974           required: true
6975           type: string
6976           example: __CLOUD-OWNER__
6977         - name: cloud-region-id
6978           in: path
6979           description: Identifier used by the vendor for the region. Second part of composite key
6980           required: true
6981           type: string
6982           example: __CLOUD-REGION-ID__
6983         - name: image-id
6984           in: path
6985           description: Image id, expected to be unique across cloud region
6986           required: true
6987           type: string
6988           example: __IMAGE-ID__
6989         - name: metaname
6990           in: path
6991           required: true
6992           type: string
6993           example: __METANAME__
6994         - name: resource-version
6995           in: query
6996           description: resource-version for concurrency
6997           required: true
6998           type: string
6999   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
7000     get:
7001       tags:
7002         - CloudInfrastructure
7003       summary: returns metadata
7004       description: returns metadata
7005       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
7006       produces:
7007         - application/json
7008         - application/xml
7009       responses:
7010         "200":
7011           description: successful operation
7012           schema:
7013               $ref: "#/getDefinitions/metadata"
7014         "default":
7015           description: Response codes found in [response codes](https://wiki.onap.org/).
7016       parameters:
7017         - name: cloud-owner
7018           in: path
7019           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7020           required: true
7021           type: string
7022           example: __CLOUD-OWNER__
7023         - name: cloud-region-id
7024           in: path
7025           description: Identifier used by the vendor for the region. Second part of composite key
7026           required: true
7027           type: string
7028           example: __CLOUD-REGION-ID__
7029         - name: image-id
7030           in: path
7031           description: Image id, expected to be unique across cloud region
7032           required: true
7033           type: string
7034           example: __IMAGE-ID__
7035         - name: cloud-type
7036           in: query
7037           description: Type of the cloud (e.g., openstack)
7038           required: false
7039           type: string
7040         - name: owner-defined-type
7041           in: query
7042           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7043           required: false
7044           type: string
7045         - name: image-name
7046           in: query
7047           description: Image name
7048           required: false
7049           type: string
7050         - name: application
7051           in: query
7052           description: The application that the image instantiates.
7053           required: false
7054           type: string
7055         - name: application-vendor
7056           in: query
7057           description: The vendor of the application.
7058           required: false
7059           type: string
7060         - name: application-version
7061           in: query
7062           description: The version of the application.
7063           required: false
7064           type: string
7065   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
7066     get:
7067       tags:
7068         - CloudInfrastructure
7069       summary: returns image
7070       description: returns image
7071       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
7072       produces:
7073         - application/json
7074         - application/xml
7075       responses:
7076         "200":
7077           description: successful operation
7078           schema:
7079               $ref: "#/getDefinitions/image"
7080         "default":
7081           description: Response codes found in [response codes](https://wiki.onap.org/).
7082       parameters:
7083         - name: cloud-owner
7084           in: path
7085           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7086           required: true
7087           type: string
7088           example: __CLOUD-OWNER__
7089         - name: cloud-region-id
7090           in: path
7091           description: Identifier used by the vendor for the region. Second part of composite key
7092           required: true
7093           type: string
7094           example: __CLOUD-REGION-ID__
7095         - name: image-id
7096           in: path
7097           description: Image id, expected to be unique across cloud region
7098           required: true
7099           type: string
7100           example: __IMAGE-ID__
7101         - name: cloud-type
7102           in: query
7103           description: Type of the cloud (e.g., openstack)
7104           required: false
7105           type: string
7106         - name: owner-defined-type
7107           in: query
7108           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7109           required: false
7110           type: string
7111         - name: image-name
7112           in: query
7113           description: Image name
7114           required: false
7115           type: string
7116         - name: application
7117           in: query
7118           description: The application that the image instantiates.
7119           required: false
7120           type: string
7121         - name: application-vendor
7122           in: query
7123           description: The vendor of the application.
7124           required: false
7125           type: string
7126         - name: application-version
7127           in: query
7128           description: The version of the application.
7129           required: false
7130           type: string
7131     put:
7132       tags:
7133         - CloudInfrastructure
7134       summary: create or update an existing image
7135       description: |
7136         Create or update an existing image.
7137         #
7138         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
7139       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
7140       consumes:
7141         - application/json
7142         - application/xml
7143       produces:
7144         - application/json
7145         - application/xml
7146       responses:
7147         "default":
7148           description: Response codes found in [response codes](https://wiki.onap.org/).
7149       parameters:
7150         - name: cloud-owner
7151           in: path
7152           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7153           required: true
7154           type: string
7155           example: __CLOUD-OWNER__
7156         - name: cloud-region-id
7157           in: path
7158           description: Identifier used by the vendor for the region. Second part of composite key
7159           required: true
7160           type: string
7161           example: __CLOUD-REGION-ID__
7162         - name: image-id
7163           in: path
7164           description: Image id, expected to be unique across cloud region
7165           required: true
7166           type: string
7167           example: __IMAGE-ID__
7168         - name: body
7169           in: body
7170           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
7171           required: true
7172           schema:
7173             $ref: "#/definitions/image"
7174     patch:
7175       tags:
7176         - CloudInfrastructure
7177       summary: update an existing image
7178       description: |
7179         Update an existing image
7180         #
7181         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7182         The PUT operation will entirely replace an existing object.
7183         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.
7184         #
7185         Other differences between PUT and PATCH are:
7186         #
7187         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7188         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7189         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7190       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
7191       consumes:
7192         - application/json
7193         - application/xml
7194       produces:
7195         - application/json
7196         - application/xml
7197       responses:
7198         "default":
7199           description: Response codes found in [response codes](https://wiki.onap.org/).
7200       parameters:
7201         - name: cloud-owner
7202           in: path
7203           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7204           required: true
7205           type: string
7206           example: __CLOUD-OWNER__
7207         - name: cloud-region-id
7208           in: path
7209           description: Identifier used by the vendor for the region. Second part of composite key
7210           required: true
7211           type: string
7212           example: __CLOUD-REGION-ID__
7213         - name: image-id
7214           in: path
7215           description: Image id, expected to be unique across cloud region
7216           required: true
7217           type: string
7218           example: __IMAGE-ID__
7219         - name: body
7220           in: body
7221           description: image object that needs to be created or updated.
7222           required: true
7223           schema:
7224             $ref: "#/patchDefinitions/image"
7225     delete:
7226       tags:
7227         - CloudInfrastructure
7228       summary: delete an existing image
7229       description: delete an existing image
7230       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
7231       consumes:
7232         - application/json
7233         - application/xml
7234       produces:
7235         - application/json
7236         - application/xml
7237       responses:
7238         "default":
7239           description: Response codes found in [response codes](https://wiki.onap.org/).
7240       parameters:
7241         - name: cloud-owner
7242           in: path
7243           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7244           required: true
7245           type: string
7246           example: __CLOUD-OWNER__
7247         - name: cloud-region-id
7248           in: path
7249           description: Identifier used by the vendor for the region. Second part of composite key
7250           required: true
7251           type: string
7252           example: __CLOUD-REGION-ID__
7253         - name: image-id
7254           in: path
7255           description: Image id, expected to be unique across cloud region
7256           required: true
7257           type: string
7258           example: __IMAGE-ID__
7259         - name: resource-version
7260           in: query
7261           description: resource-version for concurrency
7262           required: true
7263           type: string
7264   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
7265     get:
7266       tags:
7267         - CloudInfrastructure
7268       summary: returns images
7269       description: returns images
7270       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
7271       produces:
7272         - application/json
7273         - application/xml
7274       responses:
7275         "200":
7276           description: successful operation
7277           schema:
7278               $ref: "#/getDefinitions/images"
7279         "default":
7280           description: Response codes found in [response codes](https://wiki.onap.org/).
7281       parameters:
7282         - name: cloud-owner
7283           in: path
7284           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7285           required: true
7286           type: string
7287           example: __CLOUD-OWNER__
7288         - name: cloud-region-id
7289           in: path
7290           description: Identifier used by the vendor for the region. Second part of composite key
7291           required: true
7292           type: string
7293           example: __CLOUD-REGION-ID__
7294         - name: cloud-type
7295           in: query
7296           description: Type of the cloud (e.g., openstack)
7297           required: false
7298           type: string
7299         - name: owner-defined-type
7300           in: query
7301           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7302           required: false
7303           type: string
7304   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
7305     put:
7306       tags:
7307         - CloudInfrastructure
7308       summary: see node definition for valid relationships
7309       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
7310       consumes:
7311         - application/json
7312         - application/xml
7313       produces:
7314         - application/json
7315         - application/xml
7316       responses:
7317         "default":
7318           description: Response codes found in [response codes](https://wiki.onap.org/).
7319       parameters:
7320         - name: cloud-owner
7321           in: path
7322           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7323           required: true
7324           type: string
7325           example: __CLOUD-OWNER__
7326         - name: cloud-region-id
7327           in: path
7328           description: Identifier used by the vendor for the region. Second part of composite key
7329           required: true
7330           type: string
7331           example: __CLOUD-REGION-ID__
7332         - name: switch-name
7333           in: path
7334           description: DVS switch name
7335           required: true
7336           type: string
7337           example: __SWITCH-NAME__
7338         - name: body
7339           in: body
7340           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
7341           required: true
7342           schema:
7343             $ref: "#/definitions/relationship"
7344     delete:
7345       tags:
7346         - CloudInfrastructure
7347       summary: delete an existing relationship
7348       description: delete an existing relationship
7349       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
7350       consumes:
7351         - application/json
7352         - application/xml
7353       produces:
7354         - application/json
7355         - application/xml
7356       responses:
7357         "default":
7358           description: Response codes found in [response codes](https://wiki.onap.org/).
7359       parameters:
7360         - name: cloud-owner
7361           in: path
7362           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7363           required: true
7364           type: string
7365           example: __CLOUD-OWNER__
7366         - name: cloud-region-id
7367           in: path
7368           description: Identifier used by the vendor for the region. Second part of composite key
7369           required: true
7370           type: string
7371           example: __CLOUD-REGION-ID__
7372         - name: switch-name
7373           in: path
7374           description: DVS switch name
7375           required: true
7376           type: string
7377           example: __SWITCH-NAME__
7378   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
7379     get:
7380       tags:
7381         - CloudInfrastructure
7382       summary: returns dvs-switch
7383       description: returns dvs-switch
7384       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7385       produces:
7386         - application/json
7387         - application/xml
7388       responses:
7389         "200":
7390           description: successful operation
7391           schema:
7392               $ref: "#/getDefinitions/dvs-switch"
7393         "default":
7394           description: Response codes found in [response codes](https://wiki.onap.org/).
7395       parameters:
7396         - name: cloud-owner
7397           in: path
7398           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7399           required: true
7400           type: string
7401           example: __CLOUD-OWNER__
7402         - name: cloud-region-id
7403           in: path
7404           description: Identifier used by the vendor for the region. Second part of composite key
7405           required: true
7406           type: string
7407           example: __CLOUD-REGION-ID__
7408         - name: switch-name
7409           in: path
7410           description: DVS switch name
7411           required: true
7412           type: string
7413           example: __SWITCH-NAME__
7414         - name: cloud-type
7415           in: query
7416           description: Type of the cloud (e.g., openstack)
7417           required: false
7418           type: string
7419         - name: owner-defined-type
7420           in: query
7421           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7422           required: false
7423           type: string
7424         - name: vcenter-url
7425           in: query
7426           description: URL used to reach the vcenter
7427           required: false
7428           type: string
7429     put:
7430       tags:
7431         - CloudInfrastructure
7432       summary: create or update an existing dvs-switch
7433       description: |
7434         Create or update an existing dvs-switch.
7435         #
7436         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
7437       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7438       consumes:
7439         - application/json
7440         - application/xml
7441       produces:
7442         - application/json
7443         - application/xml
7444       responses:
7445         "default":
7446           description: Response codes found in [response codes](https://wiki.onap.org/).
7447       parameters:
7448         - name: cloud-owner
7449           in: path
7450           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7451           required: true
7452           type: string
7453           example: __CLOUD-OWNER__
7454         - name: cloud-region-id
7455           in: path
7456           description: Identifier used by the vendor for the region. Second part of composite key
7457           required: true
7458           type: string
7459           example: __CLOUD-REGION-ID__
7460         - name: switch-name
7461           in: path
7462           description: DVS switch name
7463           required: true
7464           type: string
7465           example: __SWITCH-NAME__
7466         - name: body
7467           in: body
7468           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
7469           required: true
7470           schema:
7471             $ref: "#/definitions/dvs-switch"
7472     patch:
7473       tags:
7474         - CloudInfrastructure
7475       summary: update an existing dvs-switch
7476       description: |
7477         Update an existing dvs-switch
7478         #
7479         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7480         The PUT operation will entirely replace an existing object.
7481         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.
7482         #
7483         Other differences between PUT and PATCH are:
7484         #
7485         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7486         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7487         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7488       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7489       consumes:
7490         - application/json
7491         - application/xml
7492       produces:
7493         - application/json
7494         - application/xml
7495       responses:
7496         "default":
7497           description: Response codes found in [response codes](https://wiki.onap.org/).
7498       parameters:
7499         - name: cloud-owner
7500           in: path
7501           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7502           required: true
7503           type: string
7504           example: __CLOUD-OWNER__
7505         - name: cloud-region-id
7506           in: path
7507           description: Identifier used by the vendor for the region. Second part of composite key
7508           required: true
7509           type: string
7510           example: __CLOUD-REGION-ID__
7511         - name: switch-name
7512           in: path
7513           description: DVS switch name
7514           required: true
7515           type: string
7516           example: __SWITCH-NAME__
7517         - name: body
7518           in: body
7519           description: dvs-switch object that needs to be created or updated.
7520           required: true
7521           schema:
7522             $ref: "#/patchDefinitions/dvs-switch"
7523     delete:
7524       tags:
7525         - CloudInfrastructure
7526       summary: delete an existing dvs-switch
7527       description: delete an existing dvs-switch
7528       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7529       consumes:
7530         - application/json
7531         - application/xml
7532       produces:
7533         - application/json
7534         - application/xml
7535       responses:
7536         "default":
7537           description: Response codes found in [response codes](https://wiki.onap.org/).
7538       parameters:
7539         - name: cloud-owner
7540           in: path
7541           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7542           required: true
7543           type: string
7544           example: __CLOUD-OWNER__
7545         - name: cloud-region-id
7546           in: path
7547           description: Identifier used by the vendor for the region. Second part of composite key
7548           required: true
7549           type: string
7550           example: __CLOUD-REGION-ID__
7551         - name: switch-name
7552           in: path
7553           description: DVS switch name
7554           required: true
7555           type: string
7556           example: __SWITCH-NAME__
7557         - name: resource-version
7558           in: query
7559           description: resource-version for concurrency
7560           required: true
7561           type: string
7562   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
7563     get:
7564       tags:
7565         - CloudInfrastructure
7566       summary: returns dvs-switches
7567       description: returns dvs-switches
7568       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
7569       produces:
7570         - application/json
7571         - application/xml
7572       responses:
7573         "200":
7574           description: successful operation
7575           schema:
7576               $ref: "#/getDefinitions/dvs-switches"
7577         "default":
7578           description: Response codes found in [response codes](https://wiki.onap.org/).
7579       parameters:
7580         - name: cloud-owner
7581           in: path
7582           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7583           required: true
7584           type: string
7585           example: __CLOUD-OWNER__
7586         - name: cloud-region-id
7587           in: path
7588           description: Identifier used by the vendor for the region. Second part of composite key
7589           required: true
7590           type: string
7591           example: __CLOUD-REGION-ID__
7592         - name: cloud-type
7593           in: query
7594           description: Type of the cloud (e.g., openstack)
7595           required: false
7596           type: string
7597         - name: owner-defined-type
7598           in: query
7599           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7600           required: false
7601           type: string
7602   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
7603     put:
7604       tags:
7605         - CloudInfrastructure
7606       summary: see node definition for valid relationships
7607       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7608       consumes:
7609         - application/json
7610         - application/xml
7611       produces:
7612         - application/json
7613         - application/xml
7614       responses:
7615         "default":
7616           description: Response codes found in [response codes](https://wiki.onap.org/).
7617       parameters:
7618         - name: cloud-owner
7619           in: path
7620           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7621           required: true
7622           type: string
7623           example: __CLOUD-OWNER__
7624         - name: cloud-region-id
7625           in: path
7626           description: Identifier used by the vendor for the region. Second part of composite key
7627           required: true
7628           type: string
7629           example: __CLOUD-REGION-ID__
7630         - name: network-uuid
7631           in: path
7632           description: UUID of the network. Unique across a cloud-region
7633           required: true
7634           type: string
7635           example: __NETWORK-UUID__
7636         - name: body
7637           in: body
7638           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7639           required: true
7640           schema:
7641             $ref: "#/definitions/relationship"
7642     delete:
7643       tags:
7644         - CloudInfrastructure
7645       summary: delete an existing relationship
7646       description: delete an existing relationship
7647       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7648       consumes:
7649         - application/json
7650         - application/xml
7651       produces:
7652         - application/json
7653         - application/xml
7654       responses:
7655         "default":
7656           description: Response codes found in [response codes](https://wiki.onap.org/).
7657       parameters:
7658         - name: cloud-owner
7659           in: path
7660           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7661           required: true
7662           type: string
7663           example: __CLOUD-OWNER__
7664         - name: cloud-region-id
7665           in: path
7666           description: Identifier used by the vendor for the region. Second part of composite key
7667           required: true
7668           type: string
7669           example: __CLOUD-REGION-ID__
7670         - name: network-uuid
7671           in: path
7672           description: UUID of the network. Unique across a cloud-region
7673           required: true
7674           type: string
7675           example: __NETWORK-UUID__
7676   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
7677     get:
7678       tags:
7679         - CloudInfrastructure
7680       summary: returns oam-network
7681       description: returns oam-network
7682       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7683       produces:
7684         - application/json
7685         - application/xml
7686       responses:
7687         "200":
7688           description: successful operation
7689           schema:
7690               $ref: "#/getDefinitions/oam-network"
7691         "default":
7692           description: Response codes found in [response codes](https://wiki.onap.org/).
7693       parameters:
7694         - name: cloud-owner
7695           in: path
7696           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7697           required: true
7698           type: string
7699           example: __CLOUD-OWNER__
7700         - name: cloud-region-id
7701           in: path
7702           description: Identifier used by the vendor for the region. Second part of composite key
7703           required: true
7704           type: string
7705           example: __CLOUD-REGION-ID__
7706         - name: network-uuid
7707           in: path
7708           description: UUID of the network. Unique across a cloud-region
7709           required: true
7710           type: string
7711           example: __NETWORK-UUID__
7712         - name: cloud-type
7713           in: query
7714           description: Type of the cloud (e.g., openstack)
7715           required: false
7716           type: string
7717         - name: owner-defined-type
7718           in: query
7719           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7720           required: false
7721           type: string
7722         - name: network-name
7723           in: query
7724           description: Name of the network.
7725           required: false
7726           type: string
7727         - name: cvlan-tag
7728           in: query
7729           description: cvlan-id
7730           required: false
7731           type: integer
7732           format: int64
7733     put:
7734       tags:
7735         - CloudInfrastructure
7736       summary: create or update an existing oam-network
7737       description: |
7738         Create or update an existing oam-network.
7739         #
7740         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
7741       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7742       consumes:
7743         - application/json
7744         - application/xml
7745       produces:
7746         - application/json
7747         - application/xml
7748       responses:
7749         "default":
7750           description: Response codes found in [response codes](https://wiki.onap.org/).
7751       parameters:
7752         - name: cloud-owner
7753           in: path
7754           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7755           required: true
7756           type: string
7757           example: __CLOUD-OWNER__
7758         - name: cloud-region-id
7759           in: path
7760           description: Identifier used by the vendor for the region. Second part of composite key
7761           required: true
7762           type: string
7763           example: __CLOUD-REGION-ID__
7764         - name: network-uuid
7765           in: path
7766           description: UUID of the network. Unique across a cloud-region
7767           required: true
7768           type: string
7769           example: __NETWORK-UUID__
7770         - name: body
7771           in: body
7772           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7773           required: true
7774           schema:
7775             $ref: "#/definitions/oam-network"
7776     patch:
7777       tags:
7778         - CloudInfrastructure
7779       summary: update an existing oam-network
7780       description: |
7781         Update an existing oam-network
7782         #
7783         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7784         The PUT operation will entirely replace an existing object.
7785         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.
7786         #
7787         Other differences between PUT and PATCH are:
7788         #
7789         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7790         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7791         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7792       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7793       consumes:
7794         - application/json
7795         - application/xml
7796       produces:
7797         - application/json
7798         - application/xml
7799       responses:
7800         "default":
7801           description: Response codes found in [response codes](https://wiki.onap.org/).
7802       parameters:
7803         - name: cloud-owner
7804           in: path
7805           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7806           required: true
7807           type: string
7808           example: __CLOUD-OWNER__
7809         - name: cloud-region-id
7810           in: path
7811           description: Identifier used by the vendor for the region. Second part of composite key
7812           required: true
7813           type: string
7814           example: __CLOUD-REGION-ID__
7815         - name: network-uuid
7816           in: path
7817           description: UUID of the network. Unique across a cloud-region
7818           required: true
7819           type: string
7820           example: __NETWORK-UUID__
7821         - name: body
7822           in: body
7823           description: oam-network object that needs to be created or updated.
7824           required: true
7825           schema:
7826             $ref: "#/patchDefinitions/oam-network"
7827     delete:
7828       tags:
7829         - CloudInfrastructure
7830       summary: delete an existing oam-network
7831       description: delete an existing oam-network
7832       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7833       consumes:
7834         - application/json
7835         - application/xml
7836       produces:
7837         - application/json
7838         - application/xml
7839       responses:
7840         "default":
7841           description: Response codes found in [response codes](https://wiki.onap.org/).
7842       parameters:
7843         - name: cloud-owner
7844           in: path
7845           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7846           required: true
7847           type: string
7848           example: __CLOUD-OWNER__
7849         - name: cloud-region-id
7850           in: path
7851           description: Identifier used by the vendor for the region. Second part of composite key
7852           required: true
7853           type: string
7854           example: __CLOUD-REGION-ID__
7855         - name: network-uuid
7856           in: path
7857           description: UUID of the network. Unique across a cloud-region
7858           required: true
7859           type: string
7860           example: __NETWORK-UUID__
7861         - name: resource-version
7862           in: query
7863           description: resource-version for concurrency
7864           required: true
7865           type: string
7866   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7867     get:
7868       tags:
7869         - CloudInfrastructure
7870       summary: returns oam-networks
7871       description: returns oam-networks
7872       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7873       produces:
7874         - application/json
7875         - application/xml
7876       responses:
7877         "200":
7878           description: successful operation
7879           schema:
7880               $ref: "#/getDefinitions/oam-networks"
7881         "default":
7882           description: Response codes found in [response codes](https://wiki.onap.org/).
7883       parameters:
7884         - name: cloud-owner
7885           in: path
7886           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7887           required: true
7888           type: string
7889           example: __CLOUD-OWNER__
7890         - name: cloud-region-id
7891           in: path
7892           description: Identifier used by the vendor for the region. Second part of composite key
7893           required: true
7894           type: string
7895           example: __CLOUD-REGION-ID__
7896         - name: cloud-type
7897           in: query
7898           description: Type of the cloud (e.g., openstack)
7899           required: false
7900           type: string
7901         - name: owner-defined-type
7902           in: query
7903           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7904           required: false
7905           type: string
7906   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7907     put:
7908       tags:
7909         - CloudInfrastructure
7910       summary: see node definition for valid relationships
7911       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7912       consumes:
7913         - application/json
7914         - application/xml
7915       produces:
7916         - application/json
7917         - application/xml
7918       responses:
7919         "default":
7920           description: Response codes found in [response codes](https://wiki.onap.org/).
7921       parameters:
7922         - name: cloud-owner
7923           in: path
7924           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7925           required: true
7926           type: string
7927           example: __CLOUD-OWNER__
7928         - name: cloud-region-id
7929           in: path
7930           description: Identifier used by the vendor for the region. Second part of composite key
7931           required: true
7932           type: string
7933           example: __CLOUD-REGION-ID__
7934         - name: availability-zone-name
7935           in: path
7936           description: Name of the availability zone.  Unique across a cloud region
7937           required: true
7938           type: string
7939           example: __AVAILABILITY-ZONE-NAME__
7940         - name: body
7941           in: body
7942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7943           required: true
7944           schema:
7945             $ref: "#/definitions/relationship"
7946     delete:
7947       tags:
7948         - CloudInfrastructure
7949       summary: delete an existing relationship
7950       description: delete an existing relationship
7951       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7952       consumes:
7953         - application/json
7954         - application/xml
7955       produces:
7956         - application/json
7957         - application/xml
7958       responses:
7959         "default":
7960           description: Response codes found in [response codes](https://wiki.onap.org/).
7961       parameters:
7962         - name: cloud-owner
7963           in: path
7964           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7965           required: true
7966           type: string
7967           example: __CLOUD-OWNER__
7968         - name: cloud-region-id
7969           in: path
7970           description: Identifier used by the vendor for the region. Second part of composite key
7971           required: true
7972           type: string
7973           example: __CLOUD-REGION-ID__
7974         - name: availability-zone-name
7975           in: path
7976           description: Name of the availability zone.  Unique across a cloud region
7977           required: true
7978           type: string
7979           example: __AVAILABILITY-ZONE-NAME__
7980   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7981     get:
7982       tags:
7983         - CloudInfrastructure
7984       summary: returns availability-zone
7985       description: returns availability-zone
7986       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7987       produces:
7988         - application/json
7989         - application/xml
7990       responses:
7991         "200":
7992           description: successful operation
7993           schema:
7994               $ref: "#/getDefinitions/availability-zone"
7995         "default":
7996           description: Response codes found in [response codes](https://wiki.onap.org/).
7997       parameters:
7998         - name: cloud-owner
7999           in: path
8000           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8001           required: true
8002           type: string
8003           example: __CLOUD-OWNER__
8004         - name: cloud-region-id
8005           in: path
8006           description: Identifier used by the vendor for the region. Second part of composite key
8007           required: true
8008           type: string
8009           example: __CLOUD-REGION-ID__
8010         - name: availability-zone-name
8011           in: path
8012           description: Name of the availability zone.  Unique across a cloud region
8013           required: true
8014           type: string
8015           example: __AVAILABILITY-ZONE-NAME__
8016         - name: cloud-type
8017           in: query
8018           description: Type of the cloud (e.g., openstack)
8019           required: false
8020           type: string
8021         - name: owner-defined-type
8022           in: query
8023           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8024           required: false
8025           type: string
8026     put:
8027       tags:
8028         - CloudInfrastructure
8029       summary: create or update an existing availability-zone
8030       description: |
8031         Create or update an existing availability-zone.
8032         #
8033         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
8034       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8035       consumes:
8036         - application/json
8037         - application/xml
8038       produces:
8039         - application/json
8040         - application/xml
8041       responses:
8042         "default":
8043           description: Response codes found in [response codes](https://wiki.onap.org/).
8044       parameters:
8045         - name: cloud-owner
8046           in: path
8047           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8048           required: true
8049           type: string
8050           example: __CLOUD-OWNER__
8051         - name: cloud-region-id
8052           in: path
8053           description: Identifier used by the vendor for the region. Second part of composite key
8054           required: true
8055           type: string
8056           example: __CLOUD-REGION-ID__
8057         - name: availability-zone-name
8058           in: path
8059           description: Name of the availability zone.  Unique across a cloud region
8060           required: true
8061           type: string
8062           example: __AVAILABILITY-ZONE-NAME__
8063         - name: body
8064           in: body
8065           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
8066           required: true
8067           schema:
8068             $ref: "#/definitions/availability-zone"
8069     patch:
8070       tags:
8071         - CloudInfrastructure
8072       summary: update an existing availability-zone
8073       description: |
8074         Update an existing availability-zone
8075         #
8076         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8077         The PUT operation will entirely replace an existing object.
8078         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.
8079         #
8080         Other differences between PUT and PATCH are:
8081         #
8082         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8083         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8084         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8085       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8086       consumes:
8087         - application/json
8088         - application/xml
8089       produces:
8090         - application/json
8091         - application/xml
8092       responses:
8093         "default":
8094           description: Response codes found in [response codes](https://wiki.onap.org/).
8095       parameters:
8096         - name: cloud-owner
8097           in: path
8098           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8099           required: true
8100           type: string
8101           example: __CLOUD-OWNER__
8102         - name: cloud-region-id
8103           in: path
8104           description: Identifier used by the vendor for the region. Second part of composite key
8105           required: true
8106           type: string
8107           example: __CLOUD-REGION-ID__
8108         - name: availability-zone-name
8109           in: path
8110           description: Name of the availability zone.  Unique across a cloud region
8111           required: true
8112           type: string
8113           example: __AVAILABILITY-ZONE-NAME__
8114         - name: body
8115           in: body
8116           description: availability-zone object that needs to be created or updated.
8117           required: true
8118           schema:
8119             $ref: "#/patchDefinitions/availability-zone"
8120     delete:
8121       tags:
8122         - CloudInfrastructure
8123       summary: delete an existing availability-zone
8124       description: delete an existing availability-zone
8125       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
8126       consumes:
8127         - application/json
8128         - application/xml
8129       produces:
8130         - application/json
8131         - application/xml
8132       responses:
8133         "default":
8134           description: Response codes found in [response codes](https://wiki.onap.org/).
8135       parameters:
8136         - name: cloud-owner
8137           in: path
8138           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8139           required: true
8140           type: string
8141           example: __CLOUD-OWNER__
8142         - name: cloud-region-id
8143           in: path
8144           description: Identifier used by the vendor for the region. Second part of composite key
8145           required: true
8146           type: string
8147           example: __CLOUD-REGION-ID__
8148         - name: availability-zone-name
8149           in: path
8150           description: Name of the availability zone.  Unique across a cloud region
8151           required: true
8152           type: string
8153           example: __AVAILABILITY-ZONE-NAME__
8154         - name: resource-version
8155           in: query
8156           description: resource-version for concurrency
8157           required: true
8158           type: string
8159   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
8160     get:
8161       tags:
8162         - CloudInfrastructure
8163       summary: returns availability-zones
8164       description: returns availability-zones
8165       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
8166       produces:
8167         - application/json
8168         - application/xml
8169       responses:
8170         "200":
8171           description: successful operation
8172           schema:
8173               $ref: "#/getDefinitions/availability-zones"
8174         "default":
8175           description: Response codes found in [response codes](https://wiki.onap.org/).
8176       parameters:
8177         - name: cloud-owner
8178           in: path
8179           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8180           required: true
8181           type: string
8182           example: __CLOUD-OWNER__
8183         - name: cloud-region-id
8184           in: path
8185           description: Identifier used by the vendor for the region. Second part of composite key
8186           required: true
8187           type: string
8188           example: __CLOUD-REGION-ID__
8189         - name: cloud-type
8190           in: query
8191           description: Type of the cloud (e.g., openstack)
8192           required: false
8193           type: string
8194         - name: owner-defined-type
8195           in: query
8196           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8197           required: false
8198           type: string
8199   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
8200     put:
8201       tags:
8202         - CloudInfrastructure
8203       summary: see node definition for valid relationships
8204       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
8205       consumes:
8206         - application/json
8207         - application/xml
8208       produces:
8209         - application/json
8210         - application/xml
8211       responses:
8212         "default":
8213           description: Response codes found in [response codes](https://wiki.onap.org/).
8214       parameters:
8215         - name: cloud-owner
8216           in: path
8217           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8218           required: true
8219           type: string
8220           example: __CLOUD-OWNER__
8221         - name: cloud-region-id
8222           in: path
8223           description: Identifier used by the vendor for the region. Second part of composite key
8224           required: true
8225           type: string
8226           example: __CLOUD-REGION-ID__
8227         - name: body
8228           in: body
8229           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
8230           required: true
8231           schema:
8232             $ref: "#/definitions/relationship"
8233     delete:
8234       tags:
8235         - CloudInfrastructure
8236       summary: delete an existing relationship
8237       description: delete an existing relationship
8238       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
8239       consumes:
8240         - application/json
8241         - application/xml
8242       produces:
8243         - application/json
8244         - application/xml
8245       responses:
8246         "default":
8247           description: Response codes found in [response codes](https://wiki.onap.org/).
8248       parameters:
8249         - name: cloud-owner
8250           in: path
8251           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8252           required: true
8253           type: string
8254           example: __CLOUD-OWNER__
8255         - name: cloud-region-id
8256           in: path
8257           description: Identifier used by the vendor for the region. Second part of composite key
8258           required: true
8259           type: string
8260           example: __CLOUD-REGION-ID__
8261   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
8262     put:
8263       tags:
8264         - CloudInfrastructure
8265       summary: see node definition for valid relationships
8266       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8267       consumes:
8268         - application/json
8269         - application/xml
8270       produces:
8271         - application/json
8272         - application/xml
8273       responses:
8274         "default":
8275           description: Response codes found in [response codes](https://wiki.onap.org/).
8276       parameters:
8277         - name: cloud-owner
8278           in: path
8279           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8280           required: true
8281           type: string
8282           example: __CLOUD-OWNER__
8283         - name: cloud-region-id
8284           in: path
8285           description: Identifier used by the vendor for the region. Second part of composite key
8286           required: true
8287           type: string
8288           example: __CLOUD-REGION-ID__
8289         - name: vip-ipv4-address
8290           in: path
8291           description: IP address
8292           required: true
8293           type: string
8294           example: __VIP-IPV4-ADDRESS__
8295         - name: body
8296           in: body
8297           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8298           required: true
8299           schema:
8300             $ref: "#/definitions/relationship"
8301     delete:
8302       tags:
8303         - CloudInfrastructure
8304       summary: delete an existing relationship
8305       description: delete an existing relationship
8306       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8307       consumes:
8308         - application/json
8309         - application/xml
8310       produces:
8311         - application/json
8312         - application/xml
8313       responses:
8314         "default":
8315           description: Response codes found in [response codes](https://wiki.onap.org/).
8316       parameters:
8317         - name: cloud-owner
8318           in: path
8319           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8320           required: true
8321           type: string
8322           example: __CLOUD-OWNER__
8323         - name: cloud-region-id
8324           in: path
8325           description: Identifier used by the vendor for the region. Second part of composite key
8326           required: true
8327           type: string
8328           example: __CLOUD-REGION-ID__
8329         - name: vip-ipv4-address
8330           in: path
8331           description: IP address
8332           required: true
8333           type: string
8334           example: __VIP-IPV4-ADDRESS__
8335   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
8336     get:
8337       tags:
8338         - CloudInfrastructure
8339       summary: returns vip-ipv4-address-list
8340       description: returns vip-ipv4-address-list
8341       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8342       produces:
8343         - application/json
8344         - application/xml
8345       responses:
8346         "200":
8347           description: successful operation
8348           schema:
8349               $ref: "#/getDefinitions/vip-ipv4-address-list"
8350         "default":
8351           description: Response codes found in [response codes](https://wiki.onap.org/).
8352       parameters:
8353         - name: cloud-owner
8354           in: path
8355           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8356           required: true
8357           type: string
8358           example: __CLOUD-OWNER__
8359         - name: cloud-region-id
8360           in: path
8361           description: Identifier used by the vendor for the region. Second part of composite key
8362           required: true
8363           type: string
8364           example: __CLOUD-REGION-ID__
8365         - name: vip-ipv4-address
8366           in: path
8367           description: IP address
8368           required: true
8369           type: string
8370           example: __VIP-IPV4-ADDRESS__
8371         - name: cloud-type
8372           in: query
8373           description: Type of the cloud (e.g., openstack)
8374           required: false
8375           type: string
8376         - name: owner-defined-type
8377           in: query
8378           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8379           required: false
8380           type: string
8381         - name: vlan-id-inner
8382           in: query
8383           description: Inner VLAN tag
8384           required: false
8385           type: integer
8386           format: int64
8387         - name: neutron-network-id
8388           in: query
8389           description: Neutron network id of the interface that address belongs to
8390           required: false
8391           type: string
8392         - name: neutron-subnet-id
8393           in: query
8394           description: Neutron id of subnet that address belongs to
8395           required: false
8396           type: string
8397     put:
8398       tags:
8399         - CloudInfrastructure
8400       summary: create or update an existing vip-ipv4-address-list
8401       description: |
8402         Create or update an existing vip-ipv4-address-list.
8403         #
8404         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
8405       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8406       consumes:
8407         - application/json
8408         - application/xml
8409       produces:
8410         - application/json
8411         - application/xml
8412       responses:
8413         "default":
8414           description: Response codes found in [response codes](https://wiki.onap.org/).
8415       parameters:
8416         - name: cloud-owner
8417           in: path
8418           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8419           required: true
8420           type: string
8421           example: __CLOUD-OWNER__
8422         - name: cloud-region-id
8423           in: path
8424           description: Identifier used by the vendor for the region. Second part of composite key
8425           required: true
8426           type: string
8427           example: __CLOUD-REGION-ID__
8428         - name: vip-ipv4-address
8429           in: path
8430           description: IP address
8431           required: true
8432           type: string
8433           example: __VIP-IPV4-ADDRESS__
8434         - name: body
8435           in: body
8436           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8437           required: true
8438           schema:
8439             $ref: "#/definitions/vip-ipv4-address-list"
8440     patch:
8441       tags:
8442         - CloudInfrastructure
8443       summary: update an existing vip-ipv4-address-list
8444       description: |
8445         Update an existing vip-ipv4-address-list
8446         #
8447         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8448         The PUT operation will entirely replace an existing object.
8449         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.
8450         #
8451         Other differences between PUT and PATCH are:
8452         #
8453         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8454         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8455         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8456       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8457       consumes:
8458         - application/json
8459         - application/xml
8460       produces:
8461         - application/json
8462         - application/xml
8463       responses:
8464         "default":
8465           description: Response codes found in [response codes](https://wiki.onap.org/).
8466       parameters:
8467         - name: cloud-owner
8468           in: path
8469           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8470           required: true
8471           type: string
8472           example: __CLOUD-OWNER__
8473         - name: cloud-region-id
8474           in: path
8475           description: Identifier used by the vendor for the region. Second part of composite key
8476           required: true
8477           type: string
8478           example: __CLOUD-REGION-ID__
8479         - name: vip-ipv4-address
8480           in: path
8481           description: IP address
8482           required: true
8483           type: string
8484           example: __VIP-IPV4-ADDRESS__
8485         - name: body
8486           in: body
8487           description: vip-ipv4-address-list object that needs to be created or updated.
8488           required: true
8489           schema:
8490             $ref: "#/patchDefinitions/vip-ipv4-address-list"
8491     delete:
8492       tags:
8493         - CloudInfrastructure
8494       summary: delete an existing vip-ipv4-address-list
8495       description: delete an existing vip-ipv4-address-list
8496       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8497       consumes:
8498         - application/json
8499         - application/xml
8500       produces:
8501         - application/json
8502         - application/xml
8503       responses:
8504         "default":
8505           description: Response codes found in [response codes](https://wiki.onap.org/).
8506       parameters:
8507         - name: cloud-owner
8508           in: path
8509           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8510           required: true
8511           type: string
8512           example: __CLOUD-OWNER__
8513         - name: cloud-region-id
8514           in: path
8515           description: Identifier used by the vendor for the region. Second part of composite key
8516           required: true
8517           type: string
8518           example: __CLOUD-REGION-ID__
8519         - name: vip-ipv4-address
8520           in: path
8521           description: IP address
8522           required: true
8523           type: string
8524           example: __VIP-IPV4-ADDRESS__
8525         - name: resource-version
8526           in: query
8527           description: resource-version for concurrency
8528           required: true
8529           type: string
8530   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
8531     put:
8532       tags:
8533         - CloudInfrastructure
8534       summary: see node definition for valid relationships
8535       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8536       consumes:
8537         - application/json
8538         - application/xml
8539       produces:
8540         - application/json
8541         - application/xml
8542       responses:
8543         "default":
8544           description: Response codes found in [response codes](https://wiki.onap.org/).
8545       parameters:
8546         - name: cloud-owner
8547           in: path
8548           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8549           required: true
8550           type: string
8551           example: __CLOUD-OWNER__
8552         - name: cloud-region-id
8553           in: path
8554           description: Identifier used by the vendor for the region. Second part of composite key
8555           required: true
8556           type: string
8557           example: __CLOUD-REGION-ID__
8558         - name: vip-ipv6-address
8559           in: path
8560           description: IP address
8561           required: true
8562           type: string
8563           example: __VIP-IPV6-ADDRESS__
8564         - name: body
8565           in: body
8566           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8567           required: true
8568           schema:
8569             $ref: "#/definitions/relationship"
8570     delete:
8571       tags:
8572         - CloudInfrastructure
8573       summary: delete an existing relationship
8574       description: delete an existing relationship
8575       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8576       consumes:
8577         - application/json
8578         - application/xml
8579       produces:
8580         - application/json
8581         - application/xml
8582       responses:
8583         "default":
8584           description: Response codes found in [response codes](https://wiki.onap.org/).
8585       parameters:
8586         - name: cloud-owner
8587           in: path
8588           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8589           required: true
8590           type: string
8591           example: __CLOUD-OWNER__
8592         - name: cloud-region-id
8593           in: path
8594           description: Identifier used by the vendor for the region. Second part of composite key
8595           required: true
8596           type: string
8597           example: __CLOUD-REGION-ID__
8598         - name: vip-ipv6-address
8599           in: path
8600           description: IP address
8601           required: true
8602           type: string
8603           example: __VIP-IPV6-ADDRESS__
8604   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
8605     get:
8606       tags:
8607         - CloudInfrastructure
8608       summary: returns vip-ipv6-address-list
8609       description: returns vip-ipv6-address-list
8610       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8611       produces:
8612         - application/json
8613         - application/xml
8614       responses:
8615         "200":
8616           description: successful operation
8617           schema:
8618               $ref: "#/getDefinitions/vip-ipv6-address-list"
8619         "default":
8620           description: Response codes found in [response codes](https://wiki.onap.org/).
8621       parameters:
8622         - name: cloud-owner
8623           in: path
8624           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8625           required: true
8626           type: string
8627           example: __CLOUD-OWNER__
8628         - name: cloud-region-id
8629           in: path
8630           description: Identifier used by the vendor for the region. Second part of composite key
8631           required: true
8632           type: string
8633           example: __CLOUD-REGION-ID__
8634         - name: vip-ipv6-address
8635           in: path
8636           description: IP address
8637           required: true
8638           type: string
8639           example: __VIP-IPV6-ADDRESS__
8640         - name: cloud-type
8641           in: query
8642           description: Type of the cloud (e.g., openstack)
8643           required: false
8644           type: string
8645         - name: owner-defined-type
8646           in: query
8647           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8648           required: false
8649           type: string
8650         - name: vlan-id-inner
8651           in: query
8652           description: Inner VLAN tag
8653           required: false
8654           type: integer
8655           format: int64
8656         - name: neutron-network-id
8657           in: query
8658           description: Neutron network id of the interface that address belongs to
8659           required: false
8660           type: string
8661         - name: neutron-subnet-id
8662           in: query
8663           description: Neutron id of subnet that address belongs to
8664           required: false
8665           type: string
8666     put:
8667       tags:
8668         - CloudInfrastructure
8669       summary: create or update an existing vip-ipv6-address-list
8670       description: |
8671         Create or update an existing vip-ipv6-address-list.
8672         #
8673         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
8674       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8675       consumes:
8676         - application/json
8677         - application/xml
8678       produces:
8679         - application/json
8680         - application/xml
8681       responses:
8682         "default":
8683           description: Response codes found in [response codes](https://wiki.onap.org/).
8684       parameters:
8685         - name: cloud-owner
8686           in: path
8687           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8688           required: true
8689           type: string
8690           example: __CLOUD-OWNER__
8691         - name: cloud-region-id
8692           in: path
8693           description: Identifier used by the vendor for the region. Second part of composite key
8694           required: true
8695           type: string
8696           example: __CLOUD-REGION-ID__
8697         - name: vip-ipv6-address
8698           in: path
8699           description: IP address
8700           required: true
8701           type: string
8702           example: __VIP-IPV6-ADDRESS__
8703         - name: body
8704           in: body
8705           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8706           required: true
8707           schema:
8708             $ref: "#/definitions/vip-ipv6-address-list"
8709     patch:
8710       tags:
8711         - CloudInfrastructure
8712       summary: update an existing vip-ipv6-address-list
8713       description: |
8714         Update an existing vip-ipv6-address-list
8715         #
8716         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8717         The PUT operation will entirely replace an existing object.
8718         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.
8719         #
8720         Other differences between PUT and PATCH are:
8721         #
8722         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8723         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8724         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8725       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8726       consumes:
8727         - application/json
8728         - application/xml
8729       produces:
8730         - application/json
8731         - application/xml
8732       responses:
8733         "default":
8734           description: Response codes found in [response codes](https://wiki.onap.org/).
8735       parameters:
8736         - name: cloud-owner
8737           in: path
8738           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8739           required: true
8740           type: string
8741           example: __CLOUD-OWNER__
8742         - name: cloud-region-id
8743           in: path
8744           description: Identifier used by the vendor for the region. Second part of composite key
8745           required: true
8746           type: string
8747           example: __CLOUD-REGION-ID__
8748         - name: vip-ipv6-address
8749           in: path
8750           description: IP address
8751           required: true
8752           type: string
8753           example: __VIP-IPV6-ADDRESS__
8754         - name: body
8755           in: body
8756           description: vip-ipv6-address-list object that needs to be created or updated.
8757           required: true
8758           schema:
8759             $ref: "#/patchDefinitions/vip-ipv6-address-list"
8760     delete:
8761       tags:
8762         - CloudInfrastructure
8763       summary: delete an existing vip-ipv6-address-list
8764       description: delete an existing vip-ipv6-address-list
8765       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8766       consumes:
8767         - application/json
8768         - application/xml
8769       produces:
8770         - application/json
8771         - application/xml
8772       responses:
8773         "default":
8774           description: Response codes found in [response codes](https://wiki.onap.org/).
8775       parameters:
8776         - name: cloud-owner
8777           in: path
8778           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8779           required: true
8780           type: string
8781           example: __CLOUD-OWNER__
8782         - name: cloud-region-id
8783           in: path
8784           description: Identifier used by the vendor for the region. Second part of composite key
8785           required: true
8786           type: string
8787           example: __CLOUD-REGION-ID__
8788         - name: vip-ipv6-address
8789           in: path
8790           description: IP address
8791           required: true
8792           type: string
8793           example: __VIP-IPV6-ADDRESS__
8794         - name: resource-version
8795           in: query
8796           description: resource-version for concurrency
8797           required: true
8798           type: string
8799   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
8800     put:
8801       tags:
8802         - CloudInfrastructure
8803       summary: see node definition for valid relationships
8804       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
8805       consumes:
8806         - application/json
8807         - application/xml
8808       produces:
8809         - application/json
8810         - application/xml
8811       responses:
8812         "default":
8813           description: Response codes found in [response codes](https://wiki.onap.org/).
8814       parameters:
8815         - name: cloud-owner
8816           in: path
8817           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8818           required: true
8819           type: string
8820           example: __CLOUD-OWNER__
8821         - name: cloud-region-id
8822           in: path
8823           description: Identifier used by the vendor for the region. Second part of composite key
8824           required: true
8825           type: string
8826           example: __CLOUD-REGION-ID__
8827         - name: hpa-capability-id
8828           in: path
8829           description: UUID to uniquely identify a HPA capability
8830           required: true
8831           type: string
8832           example: __HPA-CAPABILITY-ID__
8833         - name: body
8834           in: body
8835           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
8836           required: true
8837           schema:
8838             $ref: "#/definitions/relationship"
8839     delete:
8840       tags:
8841         - CloudInfrastructure
8842       summary: delete an existing relationship
8843       description: delete an existing relationship
8844       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
8845       consumes:
8846         - application/json
8847         - application/xml
8848       produces:
8849         - application/json
8850         - application/xml
8851       responses:
8852         "default":
8853           description: Response codes found in [response codes](https://wiki.onap.org/).
8854       parameters:
8855         - name: cloud-owner
8856           in: path
8857           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8858           required: true
8859           type: string
8860           example: __CLOUD-OWNER__
8861         - name: cloud-region-id
8862           in: path
8863           description: Identifier used by the vendor for the region. Second part of composite key
8864           required: true
8865           type: string
8866           example: __CLOUD-REGION-ID__
8867         - name: hpa-capability-id
8868           in: path
8869           description: UUID to uniquely identify a HPA capability
8870           required: true
8871           type: string
8872           example: __HPA-CAPABILITY-ID__
8873   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/relationship-list/relationship:
8874     put:
8875       tags:
8876         - CloudInfrastructure
8877       summary: see node definition for valid relationships
8878       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8879       consumes:
8880         - application/json
8881         - application/xml
8882       produces:
8883         - application/json
8884         - application/xml
8885       responses:
8886         "default":
8887           description: Response codes found in [response codes](https://wiki.onap.org/).
8888       parameters:
8889         - name: cloud-owner
8890           in: path
8891           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8892           required: true
8893           type: string
8894           example: __CLOUD-OWNER__
8895         - name: cloud-region-id
8896           in: path
8897           description: Identifier used by the vendor for the region. Second part of composite key
8898           required: true
8899           type: string
8900           example: __CLOUD-REGION-ID__
8901         - name: hpa-capability-id
8902           in: path
8903           description: UUID to uniquely identify a HPA capability
8904           required: true
8905           type: string
8906           example: __HPA-CAPABILITY-ID__
8907         - name: body
8908           in: body
8909           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8910           required: true
8911           schema:
8912             $ref: "#/definitions/relationship"
8913     delete:
8914       tags:
8915         - CloudInfrastructure
8916       summary: delete an existing relationship
8917       description: delete an existing relationship
8918       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8919       consumes:
8920         - application/json
8921         - application/xml
8922       produces:
8923         - application/json
8924         - application/xml
8925       responses:
8926         "default":
8927           description: Response codes found in [response codes](https://wiki.onap.org/).
8928       parameters:
8929         - name: cloud-owner
8930           in: path
8931           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8932           required: true
8933           type: string
8934           example: __CLOUD-OWNER__
8935         - name: cloud-region-id
8936           in: path
8937           description: Identifier used by the vendor for the region. Second part of composite key
8938           required: true
8939           type: string
8940           example: __CLOUD-REGION-ID__
8941         - name: hpa-capability-id
8942           in: path
8943           description: UUID to uniquely identify a HPA capability
8944           required: true
8945           type: string
8946           example: __HPA-CAPABILITY-ID__
8947   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes:
8948     get:
8949       tags:
8950         - CloudInfrastructure
8951       summary: returns hpa-feature-attributes
8952       description: returns hpa-feature-attributes
8953       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8954       produces:
8955         - application/json
8956         - application/xml
8957       responses:
8958         "200":
8959           description: successful operation
8960           schema:
8961               $ref: "#/getDefinitions/hpa-feature-attributes"
8962         "default":
8963           description: Response codes found in [response codes](https://wiki.onap.org/).
8964       parameters:
8965         - name: cloud-owner
8966           in: path
8967           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8968           required: true
8969           type: string
8970           example: __CLOUD-OWNER__
8971         - name: cloud-region-id
8972           in: path
8973           description: Identifier used by the vendor for the region. Second part of composite key
8974           required: true
8975           type: string
8976           example: __CLOUD-REGION-ID__
8977         - name: hpa-capability-id
8978           in: path
8979           description: UUID to uniquely identify a HPA capability
8980           required: true
8981           type: string
8982           example: __HPA-CAPABILITY-ID__
8983         - name: cloud-type
8984           in: query
8985           description: Type of the cloud (e.g., openstack)
8986           required: false
8987           type: string
8988         - name: owner-defined-type
8989           in: query
8990           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8991           required: false
8992           type: string
8993         - name: hpa-feature
8994           in: query
8995           description: Name of the HPACapability
8996           required: false
8997           type: string
8998         - name: hpa-hw-arch
8999           in: query
9000           description: Hardware architecture
9001           required: false
9002           type: string
9003   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
9004     get:
9005       tags:
9006         - CloudInfrastructure
9007       summary: returns hpa-capability
9008       description: returns hpa-capability
9009       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9010       produces:
9011         - application/json
9012         - application/xml
9013       responses:
9014         "200":
9015           description: successful operation
9016           schema:
9017               $ref: "#/getDefinitions/hpa-capability"
9018         "default":
9019           description: Response codes found in [response codes](https://wiki.onap.org/).
9020       parameters:
9021         - name: cloud-owner
9022           in: path
9023           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9024           required: true
9025           type: string
9026           example: __CLOUD-OWNER__
9027         - name: cloud-region-id
9028           in: path
9029           description: Identifier used by the vendor for the region. Second part of composite key
9030           required: true
9031           type: string
9032           example: __CLOUD-REGION-ID__
9033         - name: hpa-capability-id
9034           in: path
9035           description: UUID to uniquely identify a HPA capability
9036           required: true
9037           type: string
9038           example: __HPA-CAPABILITY-ID__
9039         - name: cloud-type
9040           in: query
9041           description: Type of the cloud (e.g., openstack)
9042           required: false
9043           type: string
9044         - name: owner-defined-type
9045           in: query
9046           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9047           required: false
9048           type: string
9049         - name: hpa-feature
9050           in: query
9051           description: Name of the HPACapability
9052           required: false
9053           type: string
9054         - name: hpa-hw-arch
9055           in: query
9056           description: Hardware architecture
9057           required: false
9058           type: string
9059     put:
9060       tags:
9061         - CloudInfrastructure
9062       summary: create or update an existing hpa-capability
9063       description: |
9064         Create or update an existing hpa-capability.
9065         #
9066         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
9067       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9068       consumes:
9069         - application/json
9070         - application/xml
9071       produces:
9072         - application/json
9073         - application/xml
9074       responses:
9075         "default":
9076           description: Response codes found in [response codes](https://wiki.onap.org/).
9077       parameters:
9078         - name: cloud-owner
9079           in: path
9080           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9081           required: true
9082           type: string
9083           example: __CLOUD-OWNER__
9084         - name: cloud-region-id
9085           in: path
9086           description: Identifier used by the vendor for the region. Second part of composite key
9087           required: true
9088           type: string
9089           example: __CLOUD-REGION-ID__
9090         - name: hpa-capability-id
9091           in: path
9092           description: UUID to uniquely identify a HPA capability
9093           required: true
9094           type: string
9095           example: __HPA-CAPABILITY-ID__
9096         - name: body
9097           in: body
9098           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
9099           required: true
9100           schema:
9101             $ref: "#/definitions/hpa-capability"
9102     patch:
9103       tags:
9104         - CloudInfrastructure
9105       summary: update an existing hpa-capability
9106       description: |
9107         Update an existing hpa-capability
9108         #
9109         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9110         The PUT operation will entirely replace an existing object.
9111         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.
9112         #
9113         Other differences between PUT and PATCH are:
9114         #
9115         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9116         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9117         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9118       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9119       consumes:
9120         - application/json
9121         - application/xml
9122       produces:
9123         - application/json
9124         - application/xml
9125       responses:
9126         "default":
9127           description: Response codes found in [response codes](https://wiki.onap.org/).
9128       parameters:
9129         - name: cloud-owner
9130           in: path
9131           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9132           required: true
9133           type: string
9134           example: __CLOUD-OWNER__
9135         - name: cloud-region-id
9136           in: path
9137           description: Identifier used by the vendor for the region. Second part of composite key
9138           required: true
9139           type: string
9140           example: __CLOUD-REGION-ID__
9141         - name: hpa-capability-id
9142           in: path
9143           description: UUID to uniquely identify a HPA capability
9144           required: true
9145           type: string
9146           example: __HPA-CAPABILITY-ID__
9147         - name: body
9148           in: body
9149           description: hpa-capability object that needs to be created or updated.
9150           required: true
9151           schema:
9152             $ref: "#/patchDefinitions/hpa-capability"
9153     delete:
9154       tags:
9155         - CloudInfrastructure
9156       summary: delete an existing hpa-capability
9157       description: delete an existing hpa-capability
9158       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
9159       consumes:
9160         - application/json
9161         - application/xml
9162       produces:
9163         - application/json
9164         - application/xml
9165       responses:
9166         "default":
9167           description: Response codes found in [response codes](https://wiki.onap.org/).
9168       parameters:
9169         - name: cloud-owner
9170           in: path
9171           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9172           required: true
9173           type: string
9174           example: __CLOUD-OWNER__
9175         - name: cloud-region-id
9176           in: path
9177           description: Identifier used by the vendor for the region. Second part of composite key
9178           required: true
9179           type: string
9180           example: __CLOUD-REGION-ID__
9181         - name: hpa-capability-id
9182           in: path
9183           description: UUID to uniquely identify a HPA capability
9184           required: true
9185           type: string
9186           example: __HPA-CAPABILITY-ID__
9187         - name: resource-version
9188           in: query
9189           description: resource-version for concurrency
9190           required: true
9191           type: string
9192   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities:
9193     get:
9194       tags:
9195         - CloudInfrastructure
9196       summary: returns hpa-capabilities
9197       description: returns hpa-capabilities
9198       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
9199       produces:
9200         - application/json
9201         - application/xml
9202       responses:
9203         "200":
9204           description: successful operation
9205           schema:
9206               $ref: "#/getDefinitions/hpa-capabilities"
9207         "default":
9208           description: Response codes found in [response codes](https://wiki.onap.org/).
9209       parameters:
9210         - name: cloud-owner
9211           in: path
9212           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9213           required: true
9214           type: string
9215           example: __CLOUD-OWNER__
9216         - name: cloud-region-id
9217           in: path
9218           description: Identifier used by the vendor for the region. Second part of composite key
9219           required: true
9220           type: string
9221           example: __CLOUD-REGION-ID__
9222         - name: cloud-type
9223           in: query
9224           description: Type of the cloud (e.g., openstack)
9225           required: false
9226           type: string
9227         - name: owner-defined-type
9228           in: query
9229           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9230           required: false
9231           type: string
9232   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
9233     get:
9234       tags:
9235         - CloudInfrastructure
9236       summary: returns cloud-region
9237       description: returns cloud-region
9238       operationId: getCloudInfrastructureCloudRegionsCloudRegion
9239       produces:
9240         - application/json
9241         - application/xml
9242       responses:
9243         "200":
9244           description: successful operation
9245           schema:
9246               $ref: "#/getDefinitions/cloud-region"
9247         "default":
9248           description: Response codes found in [response codes](https://wiki.onap.org/).
9249       parameters:
9250         - name: cloud-owner
9251           in: path
9252           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9253           required: true
9254           type: string
9255           example: __CLOUD-OWNER__
9256         - name: cloud-region-id
9257           in: path
9258           description: Identifier used by the vendor for the region. Second part of composite key
9259           required: true
9260           type: string
9261           example: __CLOUD-REGION-ID__
9262         - name: cloud-type
9263           in: query
9264           description: Type of the cloud (e.g., openstack)
9265           required: false
9266           type: string
9267         - name: owner-defined-type
9268           in: query
9269           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
9270           required: false
9271           type: string
9272     put:
9273       tags:
9274         - CloudInfrastructure
9275       summary: create or update an existing cloud-region
9276       description: |
9277         Create or update an existing cloud-region.
9278         #
9279         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
9280       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
9281       consumes:
9282         - application/json
9283         - application/xml
9284       produces:
9285         - application/json
9286         - application/xml
9287       responses:
9288         "default":
9289           description: Response codes found in [response codes](https://wiki.onap.org/).
9290       parameters:
9291         - name: cloud-owner
9292           in: path
9293           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9294           required: true
9295           type: string
9296           example: __CLOUD-OWNER__
9297         - name: cloud-region-id
9298           in: path
9299           description: Identifier used by the vendor for the region. Second part of composite key
9300           required: true
9301           type: string
9302           example: __CLOUD-REGION-ID__
9303         - name: body
9304           in: body
9305           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
9306           required: true
9307           schema:
9308             $ref: "#/definitions/cloud-region"
9309     patch:
9310       tags:
9311         - CloudInfrastructure
9312       summary: update an existing cloud-region
9313       description: |
9314         Update an existing cloud-region
9315         #
9316         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9317         The PUT operation will entirely replace an existing object.
9318         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.
9319         #
9320         Other differences between PUT and PATCH are:
9321         #
9322         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9323         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9324         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9325       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
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: cloud-owner
9337           in: path
9338           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9339           required: true
9340           type: string
9341           example: __CLOUD-OWNER__
9342         - name: cloud-region-id
9343           in: path
9344           description: Identifier used by the vendor for the region. Second part of composite key
9345           required: true
9346           type: string
9347           example: __CLOUD-REGION-ID__
9348         - name: body
9349           in: body
9350           description: cloud-region object that needs to be created or updated.
9351           required: true
9352           schema:
9353             $ref: "#/patchDefinitions/cloud-region"
9354     delete:
9355       tags:
9356         - CloudInfrastructure
9357       summary: delete an existing cloud-region
9358       description: delete an existing cloud-region
9359       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
9360       consumes:
9361         - application/json
9362         - application/xml
9363       produces:
9364         - application/json
9365         - application/xml
9366       responses:
9367         "default":
9368           description: Response codes found in [response codes](https://wiki.onap.org/).
9369       parameters:
9370         - name: cloud-owner
9371           in: path
9372           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
9373           required: true
9374           type: string
9375           example: __CLOUD-OWNER__
9376         - name: cloud-region-id
9377           in: path
9378           description: Identifier used by the vendor for the region. Second part of composite key
9379           required: true
9380           type: string
9381           example: __CLOUD-REGION-ID__
9382         - name: resource-version
9383           in: query
9384           description: resource-version for concurrency
9385           required: true
9386           type: string
9387   /cloud-infrastructure/cloud-regions:
9388     get:
9389       tags:
9390         - CloudInfrastructure
9391       summary: returns cloud-regions
9392       description: returns cloud-regions
9393       operationId: getCloudInfrastructureCloudRegions
9394       produces:
9395         - application/json
9396         - application/xml
9397       responses:
9398         "200":
9399           description: successful operation
9400           schema:
9401               $ref: "#/getDefinitions/cloud-regions"
9402         "default":
9403           description: Response codes found in [response codes](https://wiki.onap.org/).
9404   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
9405     put:
9406       tags:
9407         - CloudInfrastructure
9408       summary: see node definition for valid relationships
9409       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
9410       consumes:
9411         - application/json
9412         - application/xml
9413       produces:
9414         - application/json
9415         - application/xml
9416       responses:
9417         "default":
9418           description: Response codes found in [response codes](https://wiki.onap.org/).
9419       parameters:
9420         - name: nm-profile-name
9421           in: path
9422           description: Unique name of network profile.
9423           required: true
9424           type: string
9425           example: __NM-PROFILE-NAME__
9426         - name: body
9427           in: body
9428           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9429           required: true
9430           schema:
9431             $ref: "#/definitions/relationship"
9432     delete:
9433       tags:
9434         - CloudInfrastructure
9435       summary: delete an existing relationship
9436       description: delete an existing relationship
9437       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
9438       consumes:
9439         - application/json
9440         - application/xml
9441       produces:
9442         - application/json
9443         - application/xml
9444       responses:
9445         "default":
9446           description: Response codes found in [response codes](https://wiki.onap.org/).
9447       parameters:
9448         - name: nm-profile-name
9449           in: path
9450           description: Unique name of network profile.
9451           required: true
9452           type: string
9453           example: __NM-PROFILE-NAME__
9454   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
9455     get:
9456       tags:
9457         - CloudInfrastructure
9458       summary: returns network-profile
9459       description: returns network-profile
9460       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
9461       produces:
9462         - application/json
9463         - application/xml
9464       responses:
9465         "200":
9466           description: successful operation
9467           schema:
9468               $ref: "#/getDefinitions/network-profile"
9469         "default":
9470           description: Response codes found in [response codes](https://wiki.onap.org/).
9471       parameters:
9472         - name: nm-profile-name
9473           in: path
9474           description: Unique name of network profile.
9475           required: true
9476           type: string
9477           example: __NM-PROFILE-NAME__
9478     put:
9479       tags:
9480         - CloudInfrastructure
9481       summary: create or update an existing network-profile
9482       description: |
9483         Create or update an existing network-profile.
9484         #
9485         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
9486       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
9487       consumes:
9488         - application/json
9489         - application/xml
9490       produces:
9491         - application/json
9492         - application/xml
9493       responses:
9494         "default":
9495           description: Response codes found in [response codes](https://wiki.onap.org/).
9496       parameters:
9497         - name: nm-profile-name
9498           in: path
9499           description: Unique name of network profile.
9500           required: true
9501           type: string
9502           example: __NM-PROFILE-NAME__
9503         - name: body
9504           in: body
9505           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9506           required: true
9507           schema:
9508             $ref: "#/definitions/network-profile"
9509     patch:
9510       tags:
9511         - CloudInfrastructure
9512       summary: update an existing network-profile
9513       description: |
9514         Update an existing network-profile
9515         #
9516         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9517         The PUT operation will entirely replace an existing object.
9518         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.
9519         #
9520         Other differences between PUT and PATCH are:
9521         #
9522         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9523         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9524         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9525       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
9526       consumes:
9527         - application/json
9528         - application/xml
9529       produces:
9530         - application/json
9531         - application/xml
9532       responses:
9533         "default":
9534           description: Response codes found in [response codes](https://wiki.onap.org/).
9535       parameters:
9536         - name: nm-profile-name
9537           in: path
9538           description: Unique name of network profile.
9539           required: true
9540           type: string
9541           example: __NM-PROFILE-NAME__
9542         - name: body
9543           in: body
9544           description: network-profile object that needs to be created or updated.
9545           required: true
9546           schema:
9547             $ref: "#/patchDefinitions/network-profile"
9548     delete:
9549       tags:
9550         - CloudInfrastructure
9551       summary: delete an existing network-profile
9552       description: delete an existing network-profile
9553       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
9554       consumes:
9555         - application/json
9556         - application/xml
9557       produces:
9558         - application/json
9559         - application/xml
9560       responses:
9561         "default":
9562           description: Response codes found in [response codes](https://wiki.onap.org/).
9563       parameters:
9564         - name: nm-profile-name
9565           in: path
9566           description: Unique name of network profile.
9567           required: true
9568           type: string
9569           example: __NM-PROFILE-NAME__
9570         - name: resource-version
9571           in: query
9572           description: resource-version for concurrency
9573           required: true
9574           type: string
9575   /cloud-infrastructure/network-profiles:
9576     get:
9577       tags:
9578         - CloudInfrastructure
9579       summary: returns network-profiles
9580       description: returns network-profiles
9581       operationId: getCloudInfrastructureNetworkProfiles
9582       produces:
9583         - application/json
9584         - application/xml
9585       responses:
9586         "200":
9587           description: successful operation
9588           schema:
9589               $ref: "#/getDefinitions/network-profiles"
9590         "default":
9591           description: Response codes found in [response codes](https://wiki.onap.org/).
9592   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
9593     put:
9594       tags:
9595         - CloudInfrastructure
9596       summary: see node definition for valid relationships
9597       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
9598       consumes:
9599         - application/json
9600         - application/xml
9601       produces:
9602         - application/json
9603         - application/xml
9604       responses:
9605         "default":
9606           description: Response codes found in [response codes](https://wiki.onap.org/).
9607       parameters:
9608         - name: hostname
9609           in: path
9610           description: Value from executing hostname on the compute node.
9611           required: true
9612           type: string
9613           example: __HOSTNAME__
9614         - name: body
9615           in: body
9616           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
9617           required: true
9618           schema:
9619             $ref: "#/definitions/relationship"
9620     delete:
9621       tags:
9622         - CloudInfrastructure
9623       summary: delete an existing relationship
9624       description: delete an existing relationship
9625       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
9626       consumes:
9627         - application/json
9628         - application/xml
9629       produces:
9630         - application/json
9631         - application/xml
9632       responses:
9633         "default":
9634           description: Response codes found in [response codes](https://wiki.onap.org/).
9635       parameters:
9636         - name: hostname
9637           in: path
9638           description: Value from executing hostname on the compute node.
9639           required: true
9640           type: string
9641           example: __HOSTNAME__
9642   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
9643     put:
9644       tags:
9645         - CloudInfrastructure
9646       summary: see node definition for valid relationships
9647       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9648       consumes:
9649         - application/json
9650         - application/xml
9651       produces:
9652         - application/json
9653         - application/xml
9654       responses:
9655         "default":
9656           description: Response codes found in [response codes](https://wiki.onap.org/).
9657       parameters:
9658         - name: hostname
9659           in: path
9660           description: Value from executing hostname on the compute node.
9661           required: true
9662           type: string
9663           example: __HOSTNAME__
9664         - name: interface-name
9665           in: path
9666           description: Name that identifies the physical interface
9667           required: true
9668           type: string
9669           example: __INTERFACE-NAME__
9670         - name: body
9671           in: body
9672           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9673           required: true
9674           schema:
9675             $ref: "#/definitions/relationship"
9676     delete:
9677       tags:
9678         - CloudInfrastructure
9679       summary: delete an existing relationship
9680       description: delete an existing relationship
9681       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9682       consumes:
9683         - application/json
9684         - application/xml
9685       produces:
9686         - application/json
9687         - application/xml
9688       responses:
9689         "default":
9690           description: Response codes found in [response codes](https://wiki.onap.org/).
9691       parameters:
9692         - name: hostname
9693           in: path
9694           description: Value from executing hostname on the compute node.
9695           required: true
9696           type: string
9697           example: __HOSTNAME__
9698         - name: interface-name
9699           in: path
9700           description: Name that identifies the physical interface
9701           required: true
9702           type: string
9703           example: __INTERFACE-NAME__
9704   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
9705     put:
9706       tags:
9707         - CloudInfrastructure
9708       summary: see node definition for valid relationships
9709       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9710       consumes:
9711         - application/json
9712         - application/xml
9713       produces:
9714         - application/json
9715         - application/xml
9716       responses:
9717         "default":
9718           description: Response codes found in [response codes](https://wiki.onap.org/).
9719       parameters:
9720         - name: hostname
9721           in: path
9722           description: Value from executing hostname on the compute node.
9723           required: true
9724           type: string
9725           example: __HOSTNAME__
9726         - name: interface-name
9727           in: path
9728           description: Name that identifies the physical interface
9729           required: true
9730           type: string
9731           example: __INTERFACE-NAME__
9732         - name: pf-pci-id
9733           in: path
9734           description: Identifier for the sriov-pf
9735           required: true
9736           type: string
9737           example: __PF-PCI-ID__
9738         - name: body
9739           in: body
9740           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9741           required: true
9742           schema:
9743             $ref: "#/definitions/relationship"
9744     delete:
9745       tags:
9746         - CloudInfrastructure
9747       summary: delete an existing relationship
9748       description: delete an existing relationship
9749       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9750       consumes:
9751         - application/json
9752         - application/xml
9753       produces:
9754         - application/json
9755         - application/xml
9756       responses:
9757         "default":
9758           description: Response codes found in [response codes](https://wiki.onap.org/).
9759       parameters:
9760         - name: hostname
9761           in: path
9762           description: Value from executing hostname on the compute node.
9763           required: true
9764           type: string
9765           example: __HOSTNAME__
9766         - name: interface-name
9767           in: path
9768           description: Name that identifies the physical interface
9769           required: true
9770           type: string
9771           example: __INTERFACE-NAME__
9772         - name: pf-pci-id
9773           in: path
9774           description: Identifier for the sriov-pf
9775           required: true
9776           type: string
9777           example: __PF-PCI-ID__
9778   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9779     get:
9780       tags:
9781         - CloudInfrastructure
9782       summary: returns sriov-pf
9783       description: returns sriov-pf
9784       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9785       produces:
9786         - application/json
9787         - application/xml
9788       responses:
9789         "200":
9790           description: successful operation
9791           schema:
9792               $ref: "#/getDefinitions/sriov-pf"
9793         "default":
9794           description: Response codes found in [response codes](https://wiki.onap.org/).
9795       parameters:
9796         - name: hostname
9797           in: path
9798           description: Value from executing hostname on the compute node.
9799           required: true
9800           type: string
9801           example: __HOSTNAME__
9802         - name: interface-name
9803           in: path
9804           description: Name that identifies the physical interface
9805           required: true
9806           type: string
9807           example: __INTERFACE-NAME__
9808         - name: pf-pci-id
9809           in: path
9810           description: Identifier for the sriov-pf
9811           required: true
9812           type: string
9813           example: __PF-PCI-ID__
9814         - name: inv-status
9815           in: query
9816           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9817           required: false
9818           type: string
9819         - name: pserver-id
9820           in: query
9821           description: ID of Pserver
9822           required: false
9823           type: string
9824         - name: in-maint
9825           in: query
9826           required: false
9827           type: boolean
9828         - name: pserver-name2
9829           in: query
9830           description: alternative pserver name
9831           required: false
9832           type: string
9833         - name: prov-status
9834           in: query
9835           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9836           required: false
9837           type: string
9838     put:
9839       tags:
9840         - CloudInfrastructure
9841       summary: create or update an existing sriov-pf
9842       description: |
9843         Create or update an existing sriov-pf.
9844         #
9845         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
9846       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9847       consumes:
9848         - application/json
9849         - application/xml
9850       produces:
9851         - application/json
9852         - application/xml
9853       responses:
9854         "default":
9855           description: Response codes found in [response codes](https://wiki.onap.org/).
9856       parameters:
9857         - name: hostname
9858           in: path
9859           description: Value from executing hostname on the compute node.
9860           required: true
9861           type: string
9862           example: __HOSTNAME__
9863         - name: interface-name
9864           in: path
9865           description: Name that identifies the physical interface
9866           required: true
9867           type: string
9868           example: __INTERFACE-NAME__
9869         - name: pf-pci-id
9870           in: path
9871           description: Identifier for the sriov-pf
9872           required: true
9873           type: string
9874           example: __PF-PCI-ID__
9875         - name: body
9876           in: body
9877           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9878           required: true
9879           schema:
9880             $ref: "#/definitions/sriov-pf"
9881     patch:
9882       tags:
9883         - CloudInfrastructure
9884       summary: update an existing sriov-pf
9885       description: |
9886         Update an existing sriov-pf
9887         #
9888         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9889         The PUT operation will entirely replace an existing object.
9890         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.
9891         #
9892         Other differences between PUT and PATCH are:
9893         #
9894         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9895         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9896         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9897       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9898       consumes:
9899         - application/json
9900         - application/xml
9901       produces:
9902         - application/json
9903         - application/xml
9904       responses:
9905         "default":
9906           description: Response codes found in [response codes](https://wiki.onap.org/).
9907       parameters:
9908         - name: hostname
9909           in: path
9910           description: Value from executing hostname on the compute node.
9911           required: true
9912           type: string
9913           example: __HOSTNAME__
9914         - name: interface-name
9915           in: path
9916           description: Name that identifies the physical interface
9917           required: true
9918           type: string
9919           example: __INTERFACE-NAME__
9920         - name: pf-pci-id
9921           in: path
9922           description: Identifier for the sriov-pf
9923           required: true
9924           type: string
9925           example: __PF-PCI-ID__
9926         - name: body
9927           in: body
9928           description: sriov-pf object that needs to be created or updated.
9929           required: true
9930           schema:
9931             $ref: "#/patchDefinitions/sriov-pf"
9932     delete:
9933       tags:
9934         - CloudInfrastructure
9935       summary: delete an existing sriov-pf
9936       description: delete an existing sriov-pf
9937       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9938       consumes:
9939         - application/json
9940         - application/xml
9941       produces:
9942         - application/json
9943         - application/xml
9944       responses:
9945         "default":
9946           description: Response codes found in [response codes](https://wiki.onap.org/).
9947       parameters:
9948         - name: hostname
9949           in: path
9950           description: Value from executing hostname on the compute node.
9951           required: true
9952           type: string
9953           example: __HOSTNAME__
9954         - name: interface-name
9955           in: path
9956           description: Name that identifies the physical interface
9957           required: true
9958           type: string
9959           example: __INTERFACE-NAME__
9960         - name: pf-pci-id
9961           in: path
9962           description: Identifier for the sriov-pf
9963           required: true
9964           type: string
9965           example: __PF-PCI-ID__
9966         - name: resource-version
9967           in: query
9968           description: resource-version for concurrency
9969           required: true
9970           type: string
9971   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9972     get:
9973       tags:
9974         - CloudInfrastructure
9975       summary: returns sriov-pfs
9976       description: returns sriov-pfs
9977       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9978       produces:
9979         - application/json
9980         - application/xml
9981       responses:
9982         "200":
9983           description: successful operation
9984           schema:
9985               $ref: "#/getDefinitions/sriov-pfs"
9986         "default":
9987           description: Response codes found in [response codes](https://wiki.onap.org/).
9988       parameters:
9989         - name: hostname
9990           in: path
9991           description: Value from executing hostname on the compute node.
9992           required: true
9993           type: string
9994           example: __HOSTNAME__
9995         - name: interface-name
9996           in: path
9997           description: Name that identifies the physical interface
9998           required: true
9999           type: string
10000           example: __INTERFACE-NAME__
10001         - name: inv-status
10002           in: query
10003           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10004           required: false
10005           type: string
10006         - name: pserver-id
10007           in: query
10008           description: ID of Pserver
10009           required: false
10010           type: string
10011         - name: in-maint
10012           in: query
10013           required: false
10014           type: boolean
10015         - name: pserver-name2
10016           in: query
10017           description: alternative pserver name
10018           required: false
10019           type: string
10020         - name: prov-status
10021           in: query
10022           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10023           required: false
10024           type: string
10025   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
10026     put:
10027       tags:
10028         - CloudInfrastructure
10029       summary: see node definition for valid relationships
10030       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10031       consumes:
10032         - application/json
10033         - application/xml
10034       produces:
10035         - application/json
10036         - application/xml
10037       responses:
10038         "default":
10039           description: Response codes found in [response codes](https://wiki.onap.org/).
10040       parameters:
10041         - name: hostname
10042           in: path
10043           description: Value from executing hostname on the compute node.
10044           required: true
10045           type: string
10046           example: __HOSTNAME__
10047         - name: interface-name
10048           in: path
10049           description: Name that identifies the physical interface
10050           required: true
10051           type: string
10052           example: __INTERFACE-NAME__
10053         - name: interface-name
10054           in: path
10055           description: Name given to the interface
10056           required: true
10057           type: string
10058           example: __INTERFACE-NAME__
10059         - name: vlan-interface
10060           in: path
10061           description: String that identifies the interface
10062           required: true
10063           type: string
10064           example: __VLAN-INTERFACE__
10065         - name: body
10066           in: body
10067           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10068           required: true
10069           schema:
10070             $ref: "#/definitions/relationship"
10071     delete:
10072       tags:
10073         - CloudInfrastructure
10074       summary: delete an existing relationship
10075       description: delete an existing relationship
10076       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10077       consumes:
10078         - application/json
10079         - application/xml
10080       produces:
10081         - application/json
10082         - application/xml
10083       responses:
10084         "default":
10085           description: Response codes found in [response codes](https://wiki.onap.org/).
10086       parameters:
10087         - name: hostname
10088           in: path
10089           description: Value from executing hostname on the compute node.
10090           required: true
10091           type: string
10092           example: __HOSTNAME__
10093         - name: interface-name
10094           in: path
10095           description: Name that identifies the physical interface
10096           required: true
10097           type: string
10098           example: __INTERFACE-NAME__
10099         - name: interface-name
10100           in: path
10101           description: Name given to the interface
10102           required: true
10103           type: string
10104           example: __INTERFACE-NAME__
10105         - name: vlan-interface
10106           in: path
10107           description: String that identifies the interface
10108           required: true
10109           type: string
10110           example: __VLAN-INTERFACE__
10111   /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:
10112     put:
10113       tags:
10114         - CloudInfrastructure
10115       summary: see node definition for valid relationships
10116       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10117       consumes:
10118         - application/json
10119         - application/xml
10120       produces:
10121         - application/json
10122         - application/xml
10123       responses:
10124         "default":
10125           description: Response codes found in [response codes](https://wiki.onap.org/).
10126       parameters:
10127         - name: hostname
10128           in: path
10129           description: Value from executing hostname on the compute node.
10130           required: true
10131           type: string
10132           example: __HOSTNAME__
10133         - name: interface-name
10134           in: path
10135           description: Name that identifies the physical interface
10136           required: true
10137           type: string
10138           example: __INTERFACE-NAME__
10139         - name: interface-name
10140           in: path
10141           description: Name given to the interface
10142           required: true
10143           type: string
10144           example: __INTERFACE-NAME__
10145         - name: vlan-interface
10146           in: path
10147           description: String that identifies the interface
10148           required: true
10149           type: string
10150           example: __VLAN-INTERFACE__
10151         - name: l3-interface-ipv4-address
10152           in: path
10153           description: IP address
10154           required: true
10155           type: string
10156           example: __L3-INTERFACE-IPV4-ADDRESS__
10157         - name: body
10158           in: body
10159           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
10160           required: true
10161           schema:
10162             $ref: "#/definitions/relationship"
10163     delete:
10164       tags:
10165         - CloudInfrastructure
10166       summary: delete an existing relationship
10167       description: delete an existing relationship
10168       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10169       consumes:
10170         - application/json
10171         - application/xml
10172       produces:
10173         - application/json
10174         - application/xml
10175       responses:
10176         "default":
10177           description: Response codes found in [response codes](https://wiki.onap.org/).
10178       parameters:
10179         - name: hostname
10180           in: path
10181           description: Value from executing hostname on the compute node.
10182           required: true
10183           type: string
10184           example: __HOSTNAME__
10185         - name: interface-name
10186           in: path
10187           description: Name that identifies the physical interface
10188           required: true
10189           type: string
10190           example: __INTERFACE-NAME__
10191         - name: interface-name
10192           in: path
10193           description: Name given to the interface
10194           required: true
10195           type: string
10196           example: __INTERFACE-NAME__
10197         - name: vlan-interface
10198           in: path
10199           description: String that identifies the interface
10200           required: true
10201           type: string
10202           example: __VLAN-INTERFACE__
10203         - name: l3-interface-ipv4-address
10204           in: path
10205           description: IP address
10206           required: true
10207           type: string
10208           example: __L3-INTERFACE-IPV4-ADDRESS__
10209   /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}:
10210     get:
10211       tags:
10212         - CloudInfrastructure
10213       summary: returns l3-interface-ipv4-address-list
10214       description: returns l3-interface-ipv4-address-list
10215       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10216       produces:
10217         - application/json
10218         - application/xml
10219       responses:
10220         "200":
10221           description: successful operation
10222           schema:
10223               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10224         "default":
10225           description: Response codes found in [response codes](https://wiki.onap.org/).
10226       parameters:
10227         - name: hostname
10228           in: path
10229           description: Value from executing hostname on the compute node.
10230           required: true
10231           type: string
10232           example: __HOSTNAME__
10233         - name: interface-name
10234           in: path
10235           description: Name that identifies the physical interface
10236           required: true
10237           type: string
10238           example: __INTERFACE-NAME__
10239         - name: interface-name
10240           in: path
10241           description: Name given to the interface
10242           required: true
10243           type: string
10244           example: __INTERFACE-NAME__
10245         - name: vlan-interface
10246           in: path
10247           description: String that identifies the interface
10248           required: true
10249           type: string
10250           example: __VLAN-INTERFACE__
10251         - name: l3-interface-ipv4-address
10252           in: path
10253           description: IP address
10254           required: true
10255           type: string
10256           example: __L3-INTERFACE-IPV4-ADDRESS__
10257         - name: inv-status
10258           in: query
10259           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10260           required: false
10261           type: string
10262         - name: pserver-id
10263           in: query
10264           description: ID of Pserver
10265           required: false
10266           type: string
10267         - name: in-maint
10268           in: query
10269           required: false
10270           type: boolean
10271         - name: pserver-name2
10272           in: query
10273           description: alternative pserver name
10274           required: false
10275           type: string
10276         - name: prov-status
10277           in: query
10278           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10279           required: false
10280           type: string
10281         - name: interface-id
10282           in: query
10283           description: ID of interface
10284           required: false
10285           type: string
10286         - name: macaddr
10287           in: query
10288           description: MAC address for the interface
10289           required: false
10290           type: string
10291         - name: network-name
10292           in: query
10293           description: Name of the network
10294           required: false
10295           type: string
10296         - name: vlan-id-inner
10297           in: query
10298           description: Inner VLAN tag
10299           required: false
10300           type: integer
10301           format: int64
10302         - name: vpn-key
10303           in: query
10304           description: This indicates the customers VPN ID associated with this vlan
10305           required: false
10306           type: string
10307         - name: vlan-id-inner
10308           in: query
10309           description: Inner VLAN tag
10310           required: false
10311           type: integer
10312           format: int64
10313         - name: neutron-network-id
10314           in: query
10315           description: Neutron network id of the interface that address belongs to
10316           required: false
10317           type: string
10318         - name: neutron-subnet-id
10319           in: query
10320           description: Neutron id of subnet that address belongs to
10321           required: false
10322           type: string
10323     put:
10324       tags:
10325         - CloudInfrastructure
10326       summary: create or update an existing l3-interface-ipv4-address-list
10327       description: |
10328         Create or update an existing l3-interface-ipv4-address-list.
10329         #
10330         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
10331       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10332       consumes:
10333         - application/json
10334         - application/xml
10335       produces:
10336         - application/json
10337         - application/xml
10338       responses:
10339         "default":
10340           description: Response codes found in [response codes](https://wiki.onap.org/).
10341       parameters:
10342         - name: hostname
10343           in: path
10344           description: Value from executing hostname on the compute node.
10345           required: true
10346           type: string
10347           example: __HOSTNAME__
10348         - name: interface-name
10349           in: path
10350           description: Name that identifies the physical interface
10351           required: true
10352           type: string
10353           example: __INTERFACE-NAME__
10354         - name: interface-name
10355           in: path
10356           description: Name given to the interface
10357           required: true
10358           type: string
10359           example: __INTERFACE-NAME__
10360         - name: vlan-interface
10361           in: path
10362           description: String that identifies the interface
10363           required: true
10364           type: string
10365           example: __VLAN-INTERFACE__
10366         - name: l3-interface-ipv4-address
10367           in: path
10368           description: IP address
10369           required: true
10370           type: string
10371           example: __L3-INTERFACE-IPV4-ADDRESS__
10372         - name: body
10373           in: body
10374           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
10375           required: true
10376           schema:
10377             $ref: "#/definitions/l3-interface-ipv4-address-list"
10378     patch:
10379       tags:
10380         - CloudInfrastructure
10381       summary: update an existing l3-interface-ipv4-address-list
10382       description: |
10383         Update an existing l3-interface-ipv4-address-list
10384         #
10385         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10386         The PUT operation will entirely replace an existing object.
10387         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.
10388         #
10389         Other differences between PUT and PATCH are:
10390         #
10391         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10392         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10393         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10394       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10395       consumes:
10396         - application/json
10397         - application/xml
10398       produces:
10399         - application/json
10400         - application/xml
10401       responses:
10402         "default":
10403           description: Response codes found in [response codes](https://wiki.onap.org/).
10404       parameters:
10405         - name: hostname
10406           in: path
10407           description: Value from executing hostname on the compute node.
10408           required: true
10409           type: string
10410           example: __HOSTNAME__
10411         - name: interface-name
10412           in: path
10413           description: Name that identifies the physical interface
10414           required: true
10415           type: string
10416           example: __INTERFACE-NAME__
10417         - name: interface-name
10418           in: path
10419           description: Name given to the interface
10420           required: true
10421           type: string
10422           example: __INTERFACE-NAME__
10423         - name: vlan-interface
10424           in: path
10425           description: String that identifies the interface
10426           required: true
10427           type: string
10428           example: __VLAN-INTERFACE__
10429         - name: l3-interface-ipv4-address
10430           in: path
10431           description: IP address
10432           required: true
10433           type: string
10434           example: __L3-INTERFACE-IPV4-ADDRESS__
10435         - name: body
10436           in: body
10437           description: l3-interface-ipv4-address-list object that needs to be created or updated.
10438           required: true
10439           schema:
10440             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10441     delete:
10442       tags:
10443         - CloudInfrastructure
10444       summary: delete an existing l3-interface-ipv4-address-list
10445       description: delete an existing l3-interface-ipv4-address-list
10446       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10447       consumes:
10448         - application/json
10449         - application/xml
10450       produces:
10451         - application/json
10452         - application/xml
10453       responses:
10454         "default":
10455           description: Response codes found in [response codes](https://wiki.onap.org/).
10456       parameters:
10457         - name: hostname
10458           in: path
10459           description: Value from executing hostname on the compute node.
10460           required: true
10461           type: string
10462           example: __HOSTNAME__
10463         - name: interface-name
10464           in: path
10465           description: Name that identifies the physical interface
10466           required: true
10467           type: string
10468           example: __INTERFACE-NAME__
10469         - name: interface-name
10470           in: path
10471           description: Name given to the interface
10472           required: true
10473           type: string
10474           example: __INTERFACE-NAME__
10475         - name: vlan-interface
10476           in: path
10477           description: String that identifies the interface
10478           required: true
10479           type: string
10480           example: __VLAN-INTERFACE__
10481         - name: l3-interface-ipv4-address
10482           in: path
10483           description: IP address
10484           required: true
10485           type: string
10486           example: __L3-INTERFACE-IPV4-ADDRESS__
10487         - name: resource-version
10488           in: query
10489           description: resource-version for concurrency
10490           required: true
10491           type: string
10492   /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:
10493     put:
10494       tags:
10495         - CloudInfrastructure
10496       summary: see node definition for valid relationships
10497       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10498       consumes:
10499         - application/json
10500         - application/xml
10501       produces:
10502         - application/json
10503         - application/xml
10504       responses:
10505         "default":
10506           description: Response codes found in [response codes](https://wiki.onap.org/).
10507       parameters:
10508         - name: hostname
10509           in: path
10510           description: Value from executing hostname on the compute node.
10511           required: true
10512           type: string
10513           example: __HOSTNAME__
10514         - name: interface-name
10515           in: path
10516           description: Name that identifies the physical interface
10517           required: true
10518           type: string
10519           example: __INTERFACE-NAME__
10520         - name: interface-name
10521           in: path
10522           description: Name given to the interface
10523           required: true
10524           type: string
10525           example: __INTERFACE-NAME__
10526         - name: vlan-interface
10527           in: path
10528           description: String that identifies the interface
10529           required: true
10530           type: string
10531           example: __VLAN-INTERFACE__
10532         - name: l3-interface-ipv6-address
10533           in: path
10534           description: IP address
10535           required: true
10536           type: string
10537           example: __L3-INTERFACE-IPV6-ADDRESS__
10538         - name: body
10539           in: body
10540           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10541           required: true
10542           schema:
10543             $ref: "#/definitions/relationship"
10544     delete:
10545       tags:
10546         - CloudInfrastructure
10547       summary: delete an existing relationship
10548       description: delete an existing relationship
10549       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10550       consumes:
10551         - application/json
10552         - application/xml
10553       produces:
10554         - application/json
10555         - application/xml
10556       responses:
10557         "default":
10558           description: Response codes found in [response codes](https://wiki.onap.org/).
10559       parameters:
10560         - name: hostname
10561           in: path
10562           description: Value from executing hostname on the compute node.
10563           required: true
10564           type: string
10565           example: __HOSTNAME__
10566         - name: interface-name
10567           in: path
10568           description: Name that identifies the physical interface
10569           required: true
10570           type: string
10571           example: __INTERFACE-NAME__
10572         - name: interface-name
10573           in: path
10574           description: Name given to the interface
10575           required: true
10576           type: string
10577           example: __INTERFACE-NAME__
10578         - name: vlan-interface
10579           in: path
10580           description: String that identifies the interface
10581           required: true
10582           type: string
10583           example: __VLAN-INTERFACE__
10584         - name: l3-interface-ipv6-address
10585           in: path
10586           description: IP address
10587           required: true
10588           type: string
10589           example: __L3-INTERFACE-IPV6-ADDRESS__
10590   /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}:
10591     get:
10592       tags:
10593         - CloudInfrastructure
10594       summary: returns l3-interface-ipv6-address-list
10595       description: returns l3-interface-ipv6-address-list
10596       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10597       produces:
10598         - application/json
10599         - application/xml
10600       responses:
10601         "200":
10602           description: successful operation
10603           schema:
10604               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10605         "default":
10606           description: Response codes found in [response codes](https://wiki.onap.org/).
10607       parameters:
10608         - name: hostname
10609           in: path
10610           description: Value from executing hostname on the compute node.
10611           required: true
10612           type: string
10613           example: __HOSTNAME__
10614         - name: interface-name
10615           in: path
10616           description: Name that identifies the physical interface
10617           required: true
10618           type: string
10619           example: __INTERFACE-NAME__
10620         - name: interface-name
10621           in: path
10622           description: Name given to the interface
10623           required: true
10624           type: string
10625           example: __INTERFACE-NAME__
10626         - name: vlan-interface
10627           in: path
10628           description: String that identifies the interface
10629           required: true
10630           type: string
10631           example: __VLAN-INTERFACE__
10632         - name: l3-interface-ipv6-address
10633           in: path
10634           description: IP address
10635           required: true
10636           type: string
10637           example: __L3-INTERFACE-IPV6-ADDRESS__
10638         - name: inv-status
10639           in: query
10640           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10641           required: false
10642           type: string
10643         - name: pserver-id
10644           in: query
10645           description: ID of Pserver
10646           required: false
10647           type: string
10648         - name: in-maint
10649           in: query
10650           required: false
10651           type: boolean
10652         - name: pserver-name2
10653           in: query
10654           description: alternative pserver name
10655           required: false
10656           type: string
10657         - name: prov-status
10658           in: query
10659           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10660           required: false
10661           type: string
10662         - name: interface-id
10663           in: query
10664           description: ID of interface
10665           required: false
10666           type: string
10667         - name: macaddr
10668           in: query
10669           description: MAC address for the interface
10670           required: false
10671           type: string
10672         - name: network-name
10673           in: query
10674           description: Name of the network
10675           required: false
10676           type: string
10677         - name: vlan-id-inner
10678           in: query
10679           description: Inner VLAN tag
10680           required: false
10681           type: integer
10682           format: int64
10683         - name: vpn-key
10684           in: query
10685           description: This indicates the customers VPN ID associated with this vlan
10686           required: false
10687           type: string
10688         - name: vlan-id-inner
10689           in: query
10690           description: Inner VLAN tag
10691           required: false
10692           type: integer
10693           format: int64
10694         - name: neutron-network-id
10695           in: query
10696           description: Neutron network id of the interface that address belongs to
10697           required: false
10698           type: string
10699         - name: neutron-subnet-id
10700           in: query
10701           description: Neutron id of subnet that address belongs to
10702           required: false
10703           type: string
10704     put:
10705       tags:
10706         - CloudInfrastructure
10707       summary: create or update an existing l3-interface-ipv6-address-list
10708       description: |
10709         Create or update an existing l3-interface-ipv6-address-list.
10710         #
10711         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
10712       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10713       consumes:
10714         - application/json
10715         - application/xml
10716       produces:
10717         - application/json
10718         - application/xml
10719       responses:
10720         "default":
10721           description: Response codes found in [response codes](https://wiki.onap.org/).
10722       parameters:
10723         - name: hostname
10724           in: path
10725           description: Value from executing hostname on the compute node.
10726           required: true
10727           type: string
10728           example: __HOSTNAME__
10729         - name: interface-name
10730           in: path
10731           description: Name that identifies the physical interface
10732           required: true
10733           type: string
10734           example: __INTERFACE-NAME__
10735         - name: interface-name
10736           in: path
10737           description: Name given to the interface
10738           required: true
10739           type: string
10740           example: __INTERFACE-NAME__
10741         - name: vlan-interface
10742           in: path
10743           description: String that identifies the interface
10744           required: true
10745           type: string
10746           example: __VLAN-INTERFACE__
10747         - name: l3-interface-ipv6-address
10748           in: path
10749           description: IP address
10750           required: true
10751           type: string
10752           example: __L3-INTERFACE-IPV6-ADDRESS__
10753         - name: body
10754           in: body
10755           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10756           required: true
10757           schema:
10758             $ref: "#/definitions/l3-interface-ipv6-address-list"
10759     patch:
10760       tags:
10761         - CloudInfrastructure
10762       summary: update an existing l3-interface-ipv6-address-list
10763       description: |
10764         Update an existing l3-interface-ipv6-address-list
10765         #
10766         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10767         The PUT operation will entirely replace an existing object.
10768         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.
10769         #
10770         Other differences between PUT and PATCH are:
10771         #
10772         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10773         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10774         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10775       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10776       consumes:
10777         - application/json
10778         - application/xml
10779       produces:
10780         - application/json
10781         - application/xml
10782       responses:
10783         "default":
10784           description: Response codes found in [response codes](https://wiki.onap.org/).
10785       parameters:
10786         - name: hostname
10787           in: path
10788           description: Value from executing hostname on the compute node.
10789           required: true
10790           type: string
10791           example: __HOSTNAME__
10792         - name: interface-name
10793           in: path
10794           description: Name that identifies the physical interface
10795           required: true
10796           type: string
10797           example: __INTERFACE-NAME__
10798         - name: interface-name
10799           in: path
10800           description: Name given to the interface
10801           required: true
10802           type: string
10803           example: __INTERFACE-NAME__
10804         - name: vlan-interface
10805           in: path
10806           description: String that identifies the interface
10807           required: true
10808           type: string
10809           example: __VLAN-INTERFACE__
10810         - name: l3-interface-ipv6-address
10811           in: path
10812           description: IP address
10813           required: true
10814           type: string
10815           example: __L3-INTERFACE-IPV6-ADDRESS__
10816         - name: body
10817           in: body
10818           description: l3-interface-ipv6-address-list object that needs to be created or updated.
10819           required: true
10820           schema:
10821             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10822     delete:
10823       tags:
10824         - CloudInfrastructure
10825       summary: delete an existing l3-interface-ipv6-address-list
10826       description: delete an existing l3-interface-ipv6-address-list
10827       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10828       consumes:
10829         - application/json
10830         - application/xml
10831       produces:
10832         - application/json
10833         - application/xml
10834       responses:
10835         "default":
10836           description: Response codes found in [response codes](https://wiki.onap.org/).
10837       parameters:
10838         - name: hostname
10839           in: path
10840           description: Value from executing hostname on the compute node.
10841           required: true
10842           type: string
10843           example: __HOSTNAME__
10844         - name: interface-name
10845           in: path
10846           description: Name that identifies the physical interface
10847           required: true
10848           type: string
10849           example: __INTERFACE-NAME__
10850         - name: interface-name
10851           in: path
10852           description: Name given to the interface
10853           required: true
10854           type: string
10855           example: __INTERFACE-NAME__
10856         - name: vlan-interface
10857           in: path
10858           description: String that identifies the interface
10859           required: true
10860           type: string
10861           example: __VLAN-INTERFACE__
10862         - name: l3-interface-ipv6-address
10863           in: path
10864           description: IP address
10865           required: true
10866           type: string
10867           example: __L3-INTERFACE-IPV6-ADDRESS__
10868         - name: resource-version
10869           in: query
10870           description: resource-version for concurrency
10871           required: true
10872           type: string
10873   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10874     get:
10875       tags:
10876         - CloudInfrastructure
10877       summary: returns vlan
10878       description: returns vlan
10879       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10880       produces:
10881         - application/json
10882         - application/xml
10883       responses:
10884         "200":
10885           description: successful operation
10886           schema:
10887               $ref: "#/getDefinitions/vlan"
10888         "default":
10889           description: Response codes found in [response codes](https://wiki.onap.org/).
10890       parameters:
10891         - name: hostname
10892           in: path
10893           description: Value from executing hostname on the compute node.
10894           required: true
10895           type: string
10896           example: __HOSTNAME__
10897         - name: interface-name
10898           in: path
10899           description: Name that identifies the physical interface
10900           required: true
10901           type: string
10902           example: __INTERFACE-NAME__
10903         - name: interface-name
10904           in: path
10905           description: Name given to the interface
10906           required: true
10907           type: string
10908           example: __INTERFACE-NAME__
10909         - name: vlan-interface
10910           in: path
10911           description: String that identifies the interface
10912           required: true
10913           type: string
10914           example: __VLAN-INTERFACE__
10915         - name: inv-status
10916           in: query
10917           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10918           required: false
10919           type: string
10920         - name: pserver-id
10921           in: query
10922           description: ID of Pserver
10923           required: false
10924           type: string
10925         - name: in-maint
10926           in: query
10927           required: false
10928           type: boolean
10929         - name: pserver-name2
10930           in: query
10931           description: alternative pserver name
10932           required: false
10933           type: string
10934         - name: prov-status
10935           in: query
10936           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10937           required: false
10938           type: string
10939         - name: interface-id
10940           in: query
10941           description: ID of interface
10942           required: false
10943           type: string
10944         - name: macaddr
10945           in: query
10946           description: MAC address for the interface
10947           required: false
10948           type: string
10949         - name: network-name
10950           in: query
10951           description: Name of the network
10952           required: false
10953           type: string
10954         - name: vlan-id-inner
10955           in: query
10956           description: Inner VLAN tag
10957           required: false
10958           type: integer
10959           format: int64
10960         - name: vpn-key
10961           in: query
10962           description: This indicates the customers VPN ID associated with this vlan
10963           required: false
10964           type: string
10965     put:
10966       tags:
10967         - CloudInfrastructure
10968       summary: create or update an existing vlan
10969       description: |
10970         Create or update an existing vlan.
10971         #
10972         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
10973       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10974       consumes:
10975         - application/json
10976         - application/xml
10977       produces:
10978         - application/json
10979         - application/xml
10980       responses:
10981         "default":
10982           description: Response codes found in [response codes](https://wiki.onap.org/).
10983       parameters:
10984         - name: hostname
10985           in: path
10986           description: Value from executing hostname on the compute node.
10987           required: true
10988           type: string
10989           example: __HOSTNAME__
10990         - name: interface-name
10991           in: path
10992           description: Name that identifies the physical interface
10993           required: true
10994           type: string
10995           example: __INTERFACE-NAME__
10996         - name: interface-name
10997           in: path
10998           description: Name given to the interface
10999           required: true
11000           type: string
11001           example: __INTERFACE-NAME__
11002         - name: vlan-interface
11003           in: path
11004           description: String that identifies the interface
11005           required: true
11006           type: string
11007           example: __VLAN-INTERFACE__
11008         - name: body
11009           in: body
11010           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
11011           required: true
11012           schema:
11013             $ref: "#/definitions/vlan"
11014     patch:
11015       tags:
11016         - CloudInfrastructure
11017       summary: update an existing vlan
11018       description: |
11019         Update an existing vlan
11020         #
11021         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11022         The PUT operation will entirely replace an existing object.
11023         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.
11024         #
11025         Other differences between PUT and PATCH are:
11026         #
11027         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11028         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11029         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11030       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
11031       consumes:
11032         - application/json
11033         - application/xml
11034       produces:
11035         - application/json
11036         - application/xml
11037       responses:
11038         "default":
11039           description: Response codes found in [response codes](https://wiki.onap.org/).
11040       parameters:
11041         - name: hostname
11042           in: path
11043           description: Value from executing hostname on the compute node.
11044           required: true
11045           type: string
11046           example: __HOSTNAME__
11047         - name: interface-name
11048           in: path
11049           description: Name that identifies the physical interface
11050           required: true
11051           type: string
11052           example: __INTERFACE-NAME__
11053         - name: interface-name
11054           in: path
11055           description: Name given to the interface
11056           required: true
11057           type: string
11058           example: __INTERFACE-NAME__
11059         - name: vlan-interface
11060           in: path
11061           description: String that identifies the interface
11062           required: true
11063           type: string
11064           example: __VLAN-INTERFACE__
11065         - name: body
11066           in: body
11067           description: vlan object that needs to be created or updated.
11068           required: true
11069           schema:
11070             $ref: "#/patchDefinitions/vlan"
11071     delete:
11072       tags:
11073         - CloudInfrastructure
11074       summary: delete an existing vlan
11075       description: delete an existing vlan
11076       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
11077       consumes:
11078         - application/json
11079         - application/xml
11080       produces:
11081         - application/json
11082         - application/xml
11083       responses:
11084         "default":
11085           description: Response codes found in [response codes](https://wiki.onap.org/).
11086       parameters:
11087         - name: hostname
11088           in: path
11089           description: Value from executing hostname on the compute node.
11090           required: true
11091           type: string
11092           example: __HOSTNAME__
11093         - name: interface-name
11094           in: path
11095           description: Name that identifies the physical interface
11096           required: true
11097           type: string
11098           example: __INTERFACE-NAME__
11099         - name: interface-name
11100           in: path
11101           description: Name given to the interface
11102           required: true
11103           type: string
11104           example: __INTERFACE-NAME__
11105         - name: vlan-interface
11106           in: path
11107           description: String that identifies the interface
11108           required: true
11109           type: string
11110           example: __VLAN-INTERFACE__
11111         - name: resource-version
11112           in: query
11113           description: resource-version for concurrency
11114           required: true
11115           type: string
11116   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
11117     get:
11118       tags:
11119         - CloudInfrastructure
11120       summary: returns vlans
11121       description: returns vlans
11122       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
11123       produces:
11124         - application/json
11125         - application/xml
11126       responses:
11127         "200":
11128           description: successful operation
11129           schema:
11130               $ref: "#/getDefinitions/vlans"
11131         "default":
11132           description: Response codes found in [response codes](https://wiki.onap.org/).
11133       parameters:
11134         - name: hostname
11135           in: path
11136           description: Value from executing hostname on the compute node.
11137           required: true
11138           type: string
11139           example: __HOSTNAME__
11140         - name: interface-name
11141           in: path
11142           description: Name that identifies the physical interface
11143           required: true
11144           type: string
11145           example: __INTERFACE-NAME__
11146         - name: interface-name
11147           in: path
11148           description: Name given to the interface
11149           required: true
11150           type: string
11151           example: __INTERFACE-NAME__
11152         - name: inv-status
11153           in: query
11154           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11155           required: false
11156           type: string
11157         - name: pserver-id
11158           in: query
11159           description: ID of Pserver
11160           required: false
11161           type: string
11162         - name: in-maint
11163           in: query
11164           required: false
11165           type: boolean
11166         - name: pserver-name2
11167           in: query
11168           description: alternative pserver name
11169           required: false
11170           type: string
11171         - name: prov-status
11172           in: query
11173           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11174           required: false
11175           type: string
11176         - name: interface-id
11177           in: query
11178           description: ID of interface
11179           required: false
11180           type: string
11181         - name: macaddr
11182           in: query
11183           description: MAC address for the interface
11184           required: false
11185           type: string
11186         - name: network-name
11187           in: query
11188           description: Name of the network
11189           required: false
11190           type: string
11191   /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:
11192     put:
11193       tags:
11194         - CloudInfrastructure
11195       summary: see node definition for valid relationships
11196       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11197       consumes:
11198         - application/json
11199         - application/xml
11200       produces:
11201         - application/json
11202         - application/xml
11203       responses:
11204         "default":
11205           description: Response codes found in [response codes](https://wiki.onap.org/).
11206       parameters:
11207         - name: hostname
11208           in: path
11209           description: Value from executing hostname on the compute node.
11210           required: true
11211           type: string
11212           example: __HOSTNAME__
11213         - name: interface-name
11214           in: path
11215           description: Name that identifies the physical interface
11216           required: true
11217           type: string
11218           example: __INTERFACE-NAME__
11219         - name: interface-name
11220           in: path
11221           description: Name given to the interface
11222           required: true
11223           type: string
11224           example: __INTERFACE-NAME__
11225         - name: pci-id
11226           in: path
11227           description: PCI ID used to identify the sriov-vf
11228           required: true
11229           type: string
11230           example: __PCI-ID__
11231         - name: body
11232           in: body
11233           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11234           required: true
11235           schema:
11236             $ref: "#/definitions/relationship"
11237     delete:
11238       tags:
11239         - CloudInfrastructure
11240       summary: delete an existing relationship
11241       description: delete an existing relationship
11242       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
11243       consumes:
11244         - application/json
11245         - application/xml
11246       produces:
11247         - application/json
11248         - application/xml
11249       responses:
11250         "default":
11251           description: Response codes found in [response codes](https://wiki.onap.org/).
11252       parameters:
11253         - name: hostname
11254           in: path
11255           description: Value from executing hostname on the compute node.
11256           required: true
11257           type: string
11258           example: __HOSTNAME__
11259         - name: interface-name
11260           in: path
11261           description: Name that identifies the physical interface
11262           required: true
11263           type: string
11264           example: __INTERFACE-NAME__
11265         - name: interface-name
11266           in: path
11267           description: Name given to the interface
11268           required: true
11269           type: string
11270           example: __INTERFACE-NAME__
11271         - name: pci-id
11272           in: path
11273           description: PCI ID used to identify the sriov-vf
11274           required: true
11275           type: string
11276           example: __PCI-ID__
11277   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
11278     get:
11279       tags:
11280         - CloudInfrastructure
11281       summary: returns sriov-vf
11282       description: returns sriov-vf
11283       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11284       produces:
11285         - application/json
11286         - application/xml
11287       responses:
11288         "200":
11289           description: successful operation
11290           schema:
11291               $ref: "#/getDefinitions/sriov-vf"
11292         "default":
11293           description: Response codes found in [response codes](https://wiki.onap.org/).
11294       parameters:
11295         - name: hostname
11296           in: path
11297           description: Value from executing hostname on the compute node.
11298           required: true
11299           type: string
11300           example: __HOSTNAME__
11301         - name: interface-name
11302           in: path
11303           description: Name that identifies the physical interface
11304           required: true
11305           type: string
11306           example: __INTERFACE-NAME__
11307         - name: interface-name
11308           in: path
11309           description: Name given to the interface
11310           required: true
11311           type: string
11312           example: __INTERFACE-NAME__
11313         - name: pci-id
11314           in: path
11315           description: PCI ID used to identify the sriov-vf
11316           required: true
11317           type: string
11318           example: __PCI-ID__
11319         - name: inv-status
11320           in: query
11321           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11322           required: false
11323           type: string
11324         - name: pserver-id
11325           in: query
11326           description: ID of Pserver
11327           required: false
11328           type: string
11329         - name: in-maint
11330           in: query
11331           required: false
11332           type: boolean
11333         - name: pserver-name2
11334           in: query
11335           description: alternative pserver name
11336           required: false
11337           type: string
11338         - name: prov-status
11339           in: query
11340           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11341           required: false
11342           type: string
11343         - name: interface-id
11344           in: query
11345           description: ID of interface
11346           required: false
11347           type: string
11348         - name: macaddr
11349           in: query
11350           description: MAC address for the interface
11351           required: false
11352           type: string
11353         - name: network-name
11354           in: query
11355           description: Name of the network
11356           required: false
11357           type: string
11358         - name: vf-vlan-filter
11359           in: query
11360           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
11361           required: false
11362           type: string
11363         - name: vf-mac-filter
11364           in: query
11365           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
11366           required: false
11367           type: string
11368         - name: vf-vlan-strip
11369           in: query
11370           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
11371           required: false
11372           type: boolean
11373         - name: neutron-network-id
11374           in: query
11375           description: Neutron network id of the interface
11376           required: false
11377           type: string
11378     put:
11379       tags:
11380         - CloudInfrastructure
11381       summary: create or update an existing sriov-vf
11382       description: |
11383         Create or update an existing sriov-vf.
11384         #
11385         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
11386       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11387       consumes:
11388         - application/json
11389         - application/xml
11390       produces:
11391         - application/json
11392         - application/xml
11393       responses:
11394         "default":
11395           description: Response codes found in [response codes](https://wiki.onap.org/).
11396       parameters:
11397         - name: hostname
11398           in: path
11399           description: Value from executing hostname on the compute node.
11400           required: true
11401           type: string
11402           example: __HOSTNAME__
11403         - name: interface-name
11404           in: path
11405           description: Name that identifies the physical interface
11406           required: true
11407           type: string
11408           example: __INTERFACE-NAME__
11409         - name: interface-name
11410           in: path
11411           description: Name given to the interface
11412           required: true
11413           type: string
11414           example: __INTERFACE-NAME__
11415         - name: pci-id
11416           in: path
11417           description: PCI ID used to identify the sriov-vf
11418           required: true
11419           type: string
11420           example: __PCI-ID__
11421         - name: body
11422           in: body
11423           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
11424           required: true
11425           schema:
11426             $ref: "#/definitions/sriov-vf"
11427     patch:
11428       tags:
11429         - CloudInfrastructure
11430       summary: update an existing sriov-vf
11431       description: |
11432         Update an existing sriov-vf
11433         #
11434         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11435         The PUT operation will entirely replace an existing object.
11436         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.
11437         #
11438         Other differences between PUT and PATCH are:
11439         #
11440         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11441         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11442         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11443       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11444       consumes:
11445         - application/json
11446         - application/xml
11447       produces:
11448         - application/json
11449         - application/xml
11450       responses:
11451         "default":
11452           description: Response codes found in [response codes](https://wiki.onap.org/).
11453       parameters:
11454         - name: hostname
11455           in: path
11456           description: Value from executing hostname on the compute node.
11457           required: true
11458           type: string
11459           example: __HOSTNAME__
11460         - name: interface-name
11461           in: path
11462           description: Name that identifies the physical interface
11463           required: true
11464           type: string
11465           example: __INTERFACE-NAME__
11466         - name: interface-name
11467           in: path
11468           description: Name given to the interface
11469           required: true
11470           type: string
11471           example: __INTERFACE-NAME__
11472         - name: pci-id
11473           in: path
11474           description: PCI ID used to identify the sriov-vf
11475           required: true
11476           type: string
11477           example: __PCI-ID__
11478         - name: body
11479           in: body
11480           description: sriov-vf object that needs to be created or updated.
11481           required: true
11482           schema:
11483             $ref: "#/patchDefinitions/sriov-vf"
11484     delete:
11485       tags:
11486         - CloudInfrastructure
11487       summary: delete an existing sriov-vf
11488       description: delete an existing sriov-vf
11489       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
11490       consumes:
11491         - application/json
11492         - application/xml
11493       produces:
11494         - application/json
11495         - application/xml
11496       responses:
11497         "default":
11498           description: Response codes found in [response codes](https://wiki.onap.org/).
11499       parameters:
11500         - name: hostname
11501           in: path
11502           description: Value from executing hostname on the compute node.
11503           required: true
11504           type: string
11505           example: __HOSTNAME__
11506         - name: interface-name
11507           in: path
11508           description: Name that identifies the physical interface
11509           required: true
11510           type: string
11511           example: __INTERFACE-NAME__
11512         - name: interface-name
11513           in: path
11514           description: Name given to the interface
11515           required: true
11516           type: string
11517           example: __INTERFACE-NAME__
11518         - name: pci-id
11519           in: path
11520           description: PCI ID used to identify the sriov-vf
11521           required: true
11522           type: string
11523           example: __PCI-ID__
11524         - name: resource-version
11525           in: query
11526           description: resource-version for concurrency
11527           required: true
11528           type: string
11529   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
11530     get:
11531       tags:
11532         - CloudInfrastructure
11533       summary: returns sriov-vfs
11534       description: returns sriov-vfs
11535       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
11536       produces:
11537         - application/json
11538         - application/xml
11539       responses:
11540         "200":
11541           description: successful operation
11542           schema:
11543               $ref: "#/getDefinitions/sriov-vfs"
11544         "default":
11545           description: Response codes found in [response codes](https://wiki.onap.org/).
11546       parameters:
11547         - name: hostname
11548           in: path
11549           description: Value from executing hostname on the compute node.
11550           required: true
11551           type: string
11552           example: __HOSTNAME__
11553         - name: interface-name
11554           in: path
11555           description: Name that identifies the physical interface
11556           required: true
11557           type: string
11558           example: __INTERFACE-NAME__
11559         - name: interface-name
11560           in: path
11561           description: Name given to the interface
11562           required: true
11563           type: string
11564           example: __INTERFACE-NAME__
11565         - name: inv-status
11566           in: query
11567           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11568           required: false
11569           type: string
11570         - name: pserver-id
11571           in: query
11572           description: ID of Pserver
11573           required: false
11574           type: string
11575         - name: in-maint
11576           in: query
11577           required: false
11578           type: boolean
11579         - name: pserver-name2
11580           in: query
11581           description: alternative pserver name
11582           required: false
11583           type: string
11584         - name: prov-status
11585           in: query
11586           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11587           required: false
11588           type: string
11589         - name: interface-id
11590           in: query
11591           description: ID of interface
11592           required: false
11593           type: string
11594         - name: macaddr
11595           in: query
11596           description: MAC address for the interface
11597           required: false
11598           type: string
11599         - name: network-name
11600           in: query
11601           description: Name of the network
11602           required: false
11603           type: string
11604   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
11605     put:
11606       tags:
11607         - CloudInfrastructure
11608       summary: see node definition for valid relationships
11609       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
11610       consumes:
11611         - application/json
11612         - application/xml
11613       produces:
11614         - application/json
11615         - application/xml
11616       responses:
11617         "default":
11618           description: Response codes found in [response codes](https://wiki.onap.org/).
11619       parameters:
11620         - name: hostname
11621           in: path
11622           description: Value from executing hostname on the compute node.
11623           required: true
11624           type: string
11625           example: __HOSTNAME__
11626         - name: interface-name
11627           in: path
11628           description: Name that identifies the physical interface
11629           required: true
11630           type: string
11631           example: __INTERFACE-NAME__
11632         - name: interface-name
11633           in: path
11634           description: Name given to the interface
11635           required: true
11636           type: string
11637           example: __INTERFACE-NAME__
11638         - name: body
11639           in: body
11640           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11641           required: true
11642           schema:
11643             $ref: "#/definitions/relationship"
11644     delete:
11645       tags:
11646         - CloudInfrastructure
11647       summary: delete an existing relationship
11648       description: delete an existing relationship
11649       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
11650       consumes:
11651         - application/json
11652         - application/xml
11653       produces:
11654         - application/json
11655         - application/xml
11656       responses:
11657         "default":
11658           description: Response codes found in [response codes](https://wiki.onap.org/).
11659       parameters:
11660         - name: hostname
11661           in: path
11662           description: Value from executing hostname on the compute node.
11663           required: true
11664           type: string
11665           example: __HOSTNAME__
11666         - name: interface-name
11667           in: path
11668           description: Name that identifies the physical interface
11669           required: true
11670           type: string
11671           example: __INTERFACE-NAME__
11672         - name: interface-name
11673           in: path
11674           description: Name given to the interface
11675           required: true
11676           type: string
11677           example: __INTERFACE-NAME__
11678   /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:
11679     put:
11680       tags:
11681         - CloudInfrastructure
11682       summary: see node definition for valid relationships
11683       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11684       consumes:
11685         - application/json
11686         - application/xml
11687       produces:
11688         - application/json
11689         - application/xml
11690       responses:
11691         "default":
11692           description: Response codes found in [response codes](https://wiki.onap.org/).
11693       parameters:
11694         - name: hostname
11695           in: path
11696           description: Value from executing hostname on the compute node.
11697           required: true
11698           type: string
11699           example: __HOSTNAME__
11700         - name: interface-name
11701           in: path
11702           description: Name that identifies the physical interface
11703           required: true
11704           type: string
11705           example: __INTERFACE-NAME__
11706         - name: interface-name
11707           in: path
11708           description: Name given to the interface
11709           required: true
11710           type: string
11711           example: __INTERFACE-NAME__
11712         - name: l3-interface-ipv4-address
11713           in: path
11714           description: IP address
11715           required: true
11716           type: string
11717           example: __L3-INTERFACE-IPV4-ADDRESS__
11718         - name: body
11719           in: body
11720           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11721           required: true
11722           schema:
11723             $ref: "#/definitions/relationship"
11724     delete:
11725       tags:
11726         - CloudInfrastructure
11727       summary: delete an existing relationship
11728       description: delete an existing relationship
11729       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11730       consumes:
11731         - application/json
11732         - application/xml
11733       produces:
11734         - application/json
11735         - application/xml
11736       responses:
11737         "default":
11738           description: Response codes found in [response codes](https://wiki.onap.org/).
11739       parameters:
11740         - name: hostname
11741           in: path
11742           description: Value from executing hostname on the compute node.
11743           required: true
11744           type: string
11745           example: __HOSTNAME__
11746         - name: interface-name
11747           in: path
11748           description: Name that identifies the physical interface
11749           required: true
11750           type: string
11751           example: __INTERFACE-NAME__
11752         - name: interface-name
11753           in: path
11754           description: Name given to the interface
11755           required: true
11756           type: string
11757           example: __INTERFACE-NAME__
11758         - name: l3-interface-ipv4-address
11759           in: path
11760           description: IP address
11761           required: true
11762           type: string
11763           example: __L3-INTERFACE-IPV4-ADDRESS__
11764   /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}:
11765     get:
11766       tags:
11767         - CloudInfrastructure
11768       summary: returns l3-interface-ipv4-address-list
11769       description: returns l3-interface-ipv4-address-list
11770       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11771       produces:
11772         - application/json
11773         - application/xml
11774       responses:
11775         "200":
11776           description: successful operation
11777           schema:
11778               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11779         "default":
11780           description: Response codes found in [response codes](https://wiki.onap.org/).
11781       parameters:
11782         - name: hostname
11783           in: path
11784           description: Value from executing hostname on the compute node.
11785           required: true
11786           type: string
11787           example: __HOSTNAME__
11788         - name: interface-name
11789           in: path
11790           description: Name that identifies the physical interface
11791           required: true
11792           type: string
11793           example: __INTERFACE-NAME__
11794         - name: interface-name
11795           in: path
11796           description: Name given to the interface
11797           required: true
11798           type: string
11799           example: __INTERFACE-NAME__
11800         - name: l3-interface-ipv4-address
11801           in: path
11802           description: IP address
11803           required: true
11804           type: string
11805           example: __L3-INTERFACE-IPV4-ADDRESS__
11806         - name: inv-status
11807           in: query
11808           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11809           required: false
11810           type: string
11811         - name: pserver-id
11812           in: query
11813           description: ID of Pserver
11814           required: false
11815           type: string
11816         - name: in-maint
11817           in: query
11818           required: false
11819           type: boolean
11820         - name: pserver-name2
11821           in: query
11822           description: alternative pserver name
11823           required: false
11824           type: string
11825         - name: prov-status
11826           in: query
11827           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11828           required: false
11829           type: string
11830         - name: interface-id
11831           in: query
11832           description: ID of interface
11833           required: false
11834           type: string
11835         - name: macaddr
11836           in: query
11837           description: MAC address for the interface
11838           required: false
11839           type: string
11840         - name: network-name
11841           in: query
11842           description: Name of the network
11843           required: false
11844           type: string
11845         - name: vlan-id-inner
11846           in: query
11847           description: Inner VLAN tag
11848           required: false
11849           type: integer
11850           format: int64
11851         - name: neutron-network-id
11852           in: query
11853           description: Neutron network id of the interface that address belongs to
11854           required: false
11855           type: string
11856         - name: neutron-subnet-id
11857           in: query
11858           description: Neutron id of subnet that address belongs to
11859           required: false
11860           type: string
11861     put:
11862       tags:
11863         - CloudInfrastructure
11864       summary: create or update an existing l3-interface-ipv4-address-list
11865       description: |
11866         Create or update an existing l3-interface-ipv4-address-list.
11867         #
11868         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
11869       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11870       consumes:
11871         - application/json
11872         - application/xml
11873       produces:
11874         - application/json
11875         - application/xml
11876       responses:
11877         "default":
11878           description: Response codes found in [response codes](https://wiki.onap.org/).
11879       parameters:
11880         - name: hostname
11881           in: path
11882           description: Value from executing hostname on the compute node.
11883           required: true
11884           type: string
11885           example: __HOSTNAME__
11886         - name: interface-name
11887           in: path
11888           description: Name that identifies the physical interface
11889           required: true
11890           type: string
11891           example: __INTERFACE-NAME__
11892         - name: interface-name
11893           in: path
11894           description: Name given to the interface
11895           required: true
11896           type: string
11897           example: __INTERFACE-NAME__
11898         - name: l3-interface-ipv4-address
11899           in: path
11900           description: IP address
11901           required: true
11902           type: string
11903           example: __L3-INTERFACE-IPV4-ADDRESS__
11904         - name: body
11905           in: body
11906           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11907           required: true
11908           schema:
11909             $ref: "#/definitions/l3-interface-ipv4-address-list"
11910     patch:
11911       tags:
11912         - CloudInfrastructure
11913       summary: update an existing l3-interface-ipv4-address-list
11914       description: |
11915         Update an existing l3-interface-ipv4-address-list
11916         #
11917         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11918         The PUT operation will entirely replace an existing object.
11919         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.
11920         #
11921         Other differences between PUT and PATCH are:
11922         #
11923         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11924         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11925         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11926       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11927       consumes:
11928         - application/json
11929         - application/xml
11930       produces:
11931         - application/json
11932         - application/xml
11933       responses:
11934         "default":
11935           description: Response codes found in [response codes](https://wiki.onap.org/).
11936       parameters:
11937         - name: hostname
11938           in: path
11939           description: Value from executing hostname on the compute node.
11940           required: true
11941           type: string
11942           example: __HOSTNAME__
11943         - name: interface-name
11944           in: path
11945           description: Name that identifies the physical interface
11946           required: true
11947           type: string
11948           example: __INTERFACE-NAME__
11949         - name: interface-name
11950           in: path
11951           description: Name given to the interface
11952           required: true
11953           type: string
11954           example: __INTERFACE-NAME__
11955         - name: l3-interface-ipv4-address
11956           in: path
11957           description: IP address
11958           required: true
11959           type: string
11960           example: __L3-INTERFACE-IPV4-ADDRESS__
11961         - name: body
11962           in: body
11963           description: l3-interface-ipv4-address-list object that needs to be created or updated.
11964           required: true
11965           schema:
11966             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11967     delete:
11968       tags:
11969         - CloudInfrastructure
11970       summary: delete an existing l3-interface-ipv4-address-list
11971       description: delete an existing l3-interface-ipv4-address-list
11972       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11973       consumes:
11974         - application/json
11975         - application/xml
11976       produces:
11977         - application/json
11978         - application/xml
11979       responses:
11980         "default":
11981           description: Response codes found in [response codes](https://wiki.onap.org/).
11982       parameters:
11983         - name: hostname
11984           in: path
11985           description: Value from executing hostname on the compute node.
11986           required: true
11987           type: string
11988           example: __HOSTNAME__
11989         - name: interface-name
11990           in: path
11991           description: Name that identifies the physical interface
11992           required: true
11993           type: string
11994           example: __INTERFACE-NAME__
11995         - name: interface-name
11996           in: path
11997           description: Name given to the interface
11998           required: true
11999           type: string
12000           example: __INTERFACE-NAME__
12001         - name: l3-interface-ipv4-address
12002           in: path
12003           description: IP address
12004           required: true
12005           type: string
12006           example: __L3-INTERFACE-IPV4-ADDRESS__
12007         - name: resource-version
12008           in: query
12009           description: resource-version for concurrency
12010           required: true
12011           type: string
12012   /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:
12013     put:
12014       tags:
12015         - CloudInfrastructure
12016       summary: see node definition for valid relationships
12017       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12018       consumes:
12019         - application/json
12020         - application/xml
12021       produces:
12022         - application/json
12023         - application/xml
12024       responses:
12025         "default":
12026           description: Response codes found in [response codes](https://wiki.onap.org/).
12027       parameters:
12028         - name: hostname
12029           in: path
12030           description: Value from executing hostname on the compute node.
12031           required: true
12032           type: string
12033           example: __HOSTNAME__
12034         - name: interface-name
12035           in: path
12036           description: Name that identifies the physical interface
12037           required: true
12038           type: string
12039           example: __INTERFACE-NAME__
12040         - name: interface-name
12041           in: path
12042           description: Name given to the interface
12043           required: true
12044           type: string
12045           example: __INTERFACE-NAME__
12046         - name: l3-interface-ipv6-address
12047           in: path
12048           description: IP address
12049           required: true
12050           type: string
12051           example: __L3-INTERFACE-IPV6-ADDRESS__
12052         - name: body
12053           in: body
12054           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12055           required: true
12056           schema:
12057             $ref: "#/definitions/relationship"
12058     delete:
12059       tags:
12060         - CloudInfrastructure
12061       summary: delete an existing relationship
12062       description: delete an existing relationship
12063       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12064       consumes:
12065         - application/json
12066         - application/xml
12067       produces:
12068         - application/json
12069         - application/xml
12070       responses:
12071         "default":
12072           description: Response codes found in [response codes](https://wiki.onap.org/).
12073       parameters:
12074         - name: hostname
12075           in: path
12076           description: Value from executing hostname on the compute node.
12077           required: true
12078           type: string
12079           example: __HOSTNAME__
12080         - name: interface-name
12081           in: path
12082           description: Name that identifies the physical interface
12083           required: true
12084           type: string
12085           example: __INTERFACE-NAME__
12086         - name: interface-name
12087           in: path
12088           description: Name given to the interface
12089           required: true
12090           type: string
12091           example: __INTERFACE-NAME__
12092         - name: l3-interface-ipv6-address
12093           in: path
12094           description: IP address
12095           required: true
12096           type: string
12097           example: __L3-INTERFACE-IPV6-ADDRESS__
12098   /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}:
12099     get:
12100       tags:
12101         - CloudInfrastructure
12102       summary: returns l3-interface-ipv6-address-list
12103       description: returns l3-interface-ipv6-address-list
12104       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12105       produces:
12106         - application/json
12107         - application/xml
12108       responses:
12109         "200":
12110           description: successful operation
12111           schema:
12112               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12113         "default":
12114           description: Response codes found in [response codes](https://wiki.onap.org/).
12115       parameters:
12116         - name: hostname
12117           in: path
12118           description: Value from executing hostname on the compute node.
12119           required: true
12120           type: string
12121           example: __HOSTNAME__
12122         - name: interface-name
12123           in: path
12124           description: Name that identifies the physical interface
12125           required: true
12126           type: string
12127           example: __INTERFACE-NAME__
12128         - name: interface-name
12129           in: path
12130           description: Name given to the interface
12131           required: true
12132           type: string
12133           example: __INTERFACE-NAME__
12134         - name: l3-interface-ipv6-address
12135           in: path
12136           description: IP address
12137           required: true
12138           type: string
12139           example: __L3-INTERFACE-IPV6-ADDRESS__
12140         - name: inv-status
12141           in: query
12142           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12143           required: false
12144           type: string
12145         - name: pserver-id
12146           in: query
12147           description: ID of Pserver
12148           required: false
12149           type: string
12150         - name: in-maint
12151           in: query
12152           required: false
12153           type: boolean
12154         - name: pserver-name2
12155           in: query
12156           description: alternative pserver name
12157           required: false
12158           type: string
12159         - name: prov-status
12160           in: query
12161           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12162           required: false
12163           type: string
12164         - name: interface-id
12165           in: query
12166           description: ID of interface
12167           required: false
12168           type: string
12169         - name: macaddr
12170           in: query
12171           description: MAC address for the interface
12172           required: false
12173           type: string
12174         - name: network-name
12175           in: query
12176           description: Name of the network
12177           required: false
12178           type: string
12179         - name: vlan-id-inner
12180           in: query
12181           description: Inner VLAN tag
12182           required: false
12183           type: integer
12184           format: int64
12185         - name: neutron-network-id
12186           in: query
12187           description: Neutron network id of the interface that address belongs to
12188           required: false
12189           type: string
12190         - name: neutron-subnet-id
12191           in: query
12192           description: Neutron id of subnet that address belongs to
12193           required: false
12194           type: string
12195     put:
12196       tags:
12197         - CloudInfrastructure
12198       summary: create or update an existing l3-interface-ipv6-address-list
12199       description: |
12200         Create or update an existing l3-interface-ipv6-address-list.
12201         #
12202         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
12203       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12204       consumes:
12205         - application/json
12206         - application/xml
12207       produces:
12208         - application/json
12209         - application/xml
12210       responses:
12211         "default":
12212           description: Response codes found in [response codes](https://wiki.onap.org/).
12213       parameters:
12214         - name: hostname
12215           in: path
12216           description: Value from executing hostname on the compute node.
12217           required: true
12218           type: string
12219           example: __HOSTNAME__
12220         - name: interface-name
12221           in: path
12222           description: Name that identifies the physical interface
12223           required: true
12224           type: string
12225           example: __INTERFACE-NAME__
12226         - name: interface-name
12227           in: path
12228           description: Name given to the interface
12229           required: true
12230           type: string
12231           example: __INTERFACE-NAME__
12232         - name: l3-interface-ipv6-address
12233           in: path
12234           description: IP address
12235           required: true
12236           type: string
12237           example: __L3-INTERFACE-IPV6-ADDRESS__
12238         - name: body
12239           in: body
12240           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12241           required: true
12242           schema:
12243             $ref: "#/definitions/l3-interface-ipv6-address-list"
12244     patch:
12245       tags:
12246         - CloudInfrastructure
12247       summary: update an existing l3-interface-ipv6-address-list
12248       description: |
12249         Update an existing l3-interface-ipv6-address-list
12250         #
12251         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12252         The PUT operation will entirely replace an existing object.
12253         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.
12254         #
12255         Other differences between PUT and PATCH are:
12256         #
12257         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12258         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12259         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12260       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12261       consumes:
12262         - application/json
12263         - application/xml
12264       produces:
12265         - application/json
12266         - application/xml
12267       responses:
12268         "default":
12269           description: Response codes found in [response codes](https://wiki.onap.org/).
12270       parameters:
12271         - name: hostname
12272           in: path
12273           description: Value from executing hostname on the compute node.
12274           required: true
12275           type: string
12276           example: __HOSTNAME__
12277         - name: interface-name
12278           in: path
12279           description: Name that identifies the physical interface
12280           required: true
12281           type: string
12282           example: __INTERFACE-NAME__
12283         - name: interface-name
12284           in: path
12285           description: Name given to the interface
12286           required: true
12287           type: string
12288           example: __INTERFACE-NAME__
12289         - name: l3-interface-ipv6-address
12290           in: path
12291           description: IP address
12292           required: true
12293           type: string
12294           example: __L3-INTERFACE-IPV6-ADDRESS__
12295         - name: body
12296           in: body
12297           description: l3-interface-ipv6-address-list object that needs to be created or updated.
12298           required: true
12299           schema:
12300             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12301     delete:
12302       tags:
12303         - CloudInfrastructure
12304       summary: delete an existing l3-interface-ipv6-address-list
12305       description: delete an existing l3-interface-ipv6-address-list
12306       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12307       consumes:
12308         - application/json
12309         - application/xml
12310       produces:
12311         - application/json
12312         - application/xml
12313       responses:
12314         "default":
12315           description: Response codes found in [response codes](https://wiki.onap.org/).
12316       parameters:
12317         - name: hostname
12318           in: path
12319           description: Value from executing hostname on the compute node.
12320           required: true
12321           type: string
12322           example: __HOSTNAME__
12323         - name: interface-name
12324           in: path
12325           description: Name that identifies the physical interface
12326           required: true
12327           type: string
12328           example: __INTERFACE-NAME__
12329         - name: interface-name
12330           in: path
12331           description: Name given to the interface
12332           required: true
12333           type: string
12334           example: __INTERFACE-NAME__
12335         - name: l3-interface-ipv6-address
12336           in: path
12337           description: IP address
12338           required: true
12339           type: string
12340           example: __L3-INTERFACE-IPV6-ADDRESS__
12341         - name: resource-version
12342           in: query
12343           description: resource-version for concurrency
12344           required: true
12345           type: string
12346   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
12347     get:
12348       tags:
12349         - CloudInfrastructure
12350       summary: returns l-interface
12351       description: returns l-interface
12352       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12353       produces:
12354         - application/json
12355         - application/xml
12356       responses:
12357         "200":
12358           description: successful operation
12359           schema:
12360               $ref: "#/getDefinitions/l-interface"
12361         "default":
12362           description: Response codes found in [response codes](https://wiki.onap.org/).
12363       parameters:
12364         - name: hostname
12365           in: path
12366           description: Value from executing hostname on the compute node.
12367           required: true
12368           type: string
12369           example: __HOSTNAME__
12370         - name: interface-name
12371           in: path
12372           description: Name that identifies the physical interface
12373           required: true
12374           type: string
12375           example: __INTERFACE-NAME__
12376         - name: interface-name
12377           in: path
12378           description: Name given to the interface
12379           required: true
12380           type: string
12381           example: __INTERFACE-NAME__
12382         - name: inv-status
12383           in: query
12384           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12385           required: false
12386           type: string
12387         - name: pserver-id
12388           in: query
12389           description: ID of Pserver
12390           required: false
12391           type: string
12392         - name: in-maint
12393           in: query
12394           required: false
12395           type: boolean
12396         - name: pserver-name2
12397           in: query
12398           description: alternative pserver name
12399           required: false
12400           type: string
12401         - name: prov-status
12402           in: query
12403           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12404           required: false
12405           type: string
12406         - name: interface-id
12407           in: query
12408           description: ID of interface
12409           required: false
12410           type: string
12411         - name: macaddr
12412           in: query
12413           description: MAC address for the interface
12414           required: false
12415           type: string
12416         - name: network-name
12417           in: query
12418           description: Name of the network
12419           required: false
12420           type: string
12421     put:
12422       tags:
12423         - CloudInfrastructure
12424       summary: create or update an existing l-interface
12425       description: |
12426         Create or update an existing l-interface.
12427         #
12428         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
12429       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12430       consumes:
12431         - application/json
12432         - application/xml
12433       produces:
12434         - application/json
12435         - application/xml
12436       responses:
12437         "default":
12438           description: Response codes found in [response codes](https://wiki.onap.org/).
12439       parameters:
12440         - name: hostname
12441           in: path
12442           description: Value from executing hostname on the compute node.
12443           required: true
12444           type: string
12445           example: __HOSTNAME__
12446         - name: interface-name
12447           in: path
12448           description: Name that identifies the physical interface
12449           required: true
12450           type: string
12451           example: __INTERFACE-NAME__
12452         - name: interface-name
12453           in: path
12454           description: Name given to the interface
12455           required: true
12456           type: string
12457           example: __INTERFACE-NAME__
12458         - name: body
12459           in: body
12460           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
12461           required: true
12462           schema:
12463             $ref: "#/definitions/l-interface"
12464     patch:
12465       tags:
12466         - CloudInfrastructure
12467       summary: update an existing l-interface
12468       description: |
12469         Update an existing l-interface
12470         #
12471         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12472         The PUT operation will entirely replace an existing object.
12473         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.
12474         #
12475         Other differences between PUT and PATCH are:
12476         #
12477         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12478         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12479         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12480       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12481       consumes:
12482         - application/json
12483         - application/xml
12484       produces:
12485         - application/json
12486         - application/xml
12487       responses:
12488         "default":
12489           description: Response codes found in [response codes](https://wiki.onap.org/).
12490       parameters:
12491         - name: hostname
12492           in: path
12493           description: Value from executing hostname on the compute node.
12494           required: true
12495           type: string
12496           example: __HOSTNAME__
12497         - name: interface-name
12498           in: path
12499           description: Name that identifies the physical interface
12500           required: true
12501           type: string
12502           example: __INTERFACE-NAME__
12503         - name: interface-name
12504           in: path
12505           description: Name given to the interface
12506           required: true
12507           type: string
12508           example: __INTERFACE-NAME__
12509         - name: body
12510           in: body
12511           description: l-interface object that needs to be created or updated.
12512           required: true
12513           schema:
12514             $ref: "#/patchDefinitions/l-interface"
12515     delete:
12516       tags:
12517         - CloudInfrastructure
12518       summary: delete an existing l-interface
12519       description: delete an existing l-interface
12520       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
12521       consumes:
12522         - application/json
12523         - application/xml
12524       produces:
12525         - application/json
12526         - application/xml
12527       responses:
12528         "default":
12529           description: Response codes found in [response codes](https://wiki.onap.org/).
12530       parameters:
12531         - name: hostname
12532           in: path
12533           description: Value from executing hostname on the compute node.
12534           required: true
12535           type: string
12536           example: __HOSTNAME__
12537         - name: interface-name
12538           in: path
12539           description: Name that identifies the physical interface
12540           required: true
12541           type: string
12542           example: __INTERFACE-NAME__
12543         - name: interface-name
12544           in: path
12545           description: Name given to the interface
12546           required: true
12547           type: string
12548           example: __INTERFACE-NAME__
12549         - name: resource-version
12550           in: query
12551           description: resource-version for concurrency
12552           required: true
12553           type: string
12554   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
12555     get:
12556       tags:
12557         - CloudInfrastructure
12558       summary: returns l-interfaces
12559       description: returns l-interfaces
12560       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
12561       produces:
12562         - application/json
12563         - application/xml
12564       responses:
12565         "200":
12566           description: successful operation
12567           schema:
12568               $ref: "#/getDefinitions/l-interfaces"
12569         "default":
12570           description: Response codes found in [response codes](https://wiki.onap.org/).
12571       parameters:
12572         - name: hostname
12573           in: path
12574           description: Value from executing hostname on the compute node.
12575           required: true
12576           type: string
12577           example: __HOSTNAME__
12578         - name: interface-name
12579           in: path
12580           description: Name that identifies the physical interface
12581           required: true
12582           type: string
12583           example: __INTERFACE-NAME__
12584         - name: inv-status
12585           in: query
12586           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12587           required: false
12588           type: string
12589         - name: pserver-id
12590           in: query
12591           description: ID of Pserver
12592           required: false
12593           type: string
12594         - name: in-maint
12595           in: query
12596           required: false
12597           type: boolean
12598         - name: pserver-name2
12599           in: query
12600           description: alternative pserver name
12601           required: false
12602           type: string
12603         - name: prov-status
12604           in: query
12605           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12606           required: false
12607           type: string
12608   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
12609     get:
12610       tags:
12611         - CloudInfrastructure
12612       summary: returns p-interface
12613       description: returns p-interface
12614       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
12615       produces:
12616         - application/json
12617         - application/xml
12618       responses:
12619         "200":
12620           description: successful operation
12621           schema:
12622               $ref: "#/getDefinitions/p-interface"
12623         "default":
12624           description: Response codes found in [response codes](https://wiki.onap.org/).
12625       parameters:
12626         - name: hostname
12627           in: path
12628           description: Value from executing hostname on the compute node.
12629           required: true
12630           type: string
12631           example: __HOSTNAME__
12632         - name: interface-name
12633           in: path
12634           description: Name that identifies the physical interface
12635           required: true
12636           type: string
12637           example: __INTERFACE-NAME__
12638         - name: inv-status
12639           in: query
12640           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12641           required: false
12642           type: string
12643         - name: pserver-id
12644           in: query
12645           description: ID of Pserver
12646           required: false
12647           type: string
12648         - name: in-maint
12649           in: query
12650           required: false
12651           type: boolean
12652         - name: pserver-name2
12653           in: query
12654           description: alternative pserver name
12655           required: false
12656           type: string
12657         - name: prov-status
12658           in: query
12659           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12660           required: false
12661           type: string
12662     put:
12663       tags:
12664         - CloudInfrastructure
12665       summary: create or update an existing p-interface
12666       description: |
12667         Create or update an existing p-interface.
12668         #
12669         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
12670       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
12671       consumes:
12672         - application/json
12673         - application/xml
12674       produces:
12675         - application/json
12676         - application/xml
12677       responses:
12678         "default":
12679           description: Response codes found in [response codes](https://wiki.onap.org/).
12680       parameters:
12681         - name: hostname
12682           in: path
12683           description: Value from executing hostname on the compute node.
12684           required: true
12685           type: string
12686           example: __HOSTNAME__
12687         - name: interface-name
12688           in: path
12689           description: Name that identifies the physical interface
12690           required: true
12691           type: string
12692           example: __INTERFACE-NAME__
12693         - name: body
12694           in: body
12695           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
12696           required: true
12697           schema:
12698             $ref: "#/definitions/p-interface"
12699     patch:
12700       tags:
12701         - CloudInfrastructure
12702       summary: update an existing p-interface
12703       description: |
12704         Update an existing p-interface
12705         #
12706         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12707         The PUT operation will entirely replace an existing object.
12708         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.
12709         #
12710         Other differences between PUT and PATCH are:
12711         #
12712         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12713         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12714         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12715       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
12716       consumes:
12717         - application/json
12718         - application/xml
12719       produces:
12720         - application/json
12721         - application/xml
12722       responses:
12723         "default":
12724           description: Response codes found in [response codes](https://wiki.onap.org/).
12725       parameters:
12726         - name: hostname
12727           in: path
12728           description: Value from executing hostname on the compute node.
12729           required: true
12730           type: string
12731           example: __HOSTNAME__
12732         - name: interface-name
12733           in: path
12734           description: Name that identifies the physical interface
12735           required: true
12736           type: string
12737           example: __INTERFACE-NAME__
12738         - name: body
12739           in: body
12740           description: p-interface object that needs to be created or updated.
12741           required: true
12742           schema:
12743             $ref: "#/patchDefinitions/p-interface"
12744     delete:
12745       tags:
12746         - CloudInfrastructure
12747       summary: delete an existing p-interface
12748       description: delete an existing p-interface
12749       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
12750       consumes:
12751         - application/json
12752         - application/xml
12753       produces:
12754         - application/json
12755         - application/xml
12756       responses:
12757         "default":
12758           description: Response codes found in [response codes](https://wiki.onap.org/).
12759       parameters:
12760         - name: hostname
12761           in: path
12762           description: Value from executing hostname on the compute node.
12763           required: true
12764           type: string
12765           example: __HOSTNAME__
12766         - name: interface-name
12767           in: path
12768           description: Name that identifies the physical interface
12769           required: true
12770           type: string
12771           example: __INTERFACE-NAME__
12772         - name: resource-version
12773           in: query
12774           description: resource-version for concurrency
12775           required: true
12776           type: string
12777   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
12778     get:
12779       tags:
12780         - CloudInfrastructure
12781       summary: returns p-interfaces
12782       description: returns p-interfaces
12783       operationId: getCloudInfrastructurePserversPserverPInterfaces
12784       produces:
12785         - application/json
12786         - application/xml
12787       responses:
12788         "200":
12789           description: successful operation
12790           schema:
12791               $ref: "#/getDefinitions/p-interfaces"
12792         "default":
12793           description: Response codes found in [response codes](https://wiki.onap.org/).
12794       parameters:
12795         - name: hostname
12796           in: path
12797           description: Value from executing hostname on the compute node.
12798           required: true
12799           type: string
12800           example: __HOSTNAME__
12801         - name: inv-status
12802           in: query
12803           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12804           required: false
12805           type: string
12806         - name: pserver-id
12807           in: query
12808           description: ID of Pserver
12809           required: false
12810           type: string
12811         - name: in-maint
12812           in: query
12813           required: false
12814           type: boolean
12815         - name: pserver-name2
12816           in: query
12817           description: alternative pserver name
12818           required: false
12819           type: string
12820   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
12821     put:
12822       tags:
12823         - CloudInfrastructure
12824       summary: see node definition for valid relationships
12825       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
12826       consumes:
12827         - application/json
12828         - application/xml
12829       produces:
12830         - application/json
12831         - application/xml
12832       responses:
12833         "default":
12834           description: Response codes found in [response codes](https://wiki.onap.org/).
12835       parameters:
12836         - name: hostname
12837           in: path
12838           description: Value from executing hostname on the compute node.
12839           required: true
12840           type: string
12841           example: __HOSTNAME__
12842         - name: interface-name
12843           in: path
12844           description: Name that identifies the link aggregate interface
12845           required: true
12846           type: string
12847           example: __INTERFACE-NAME__
12848         - name: body
12849           in: body
12850           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
12851           required: true
12852           schema:
12853             $ref: "#/definitions/relationship"
12854     delete:
12855       tags:
12856         - CloudInfrastructure
12857       summary: delete an existing relationship
12858       description: delete an existing relationship
12859       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
12860       consumes:
12861         - application/json
12862         - application/xml
12863       produces:
12864         - application/json
12865         - application/xml
12866       responses:
12867         "default":
12868           description: Response codes found in [response codes](https://wiki.onap.org/).
12869       parameters:
12870         - name: hostname
12871           in: path
12872           description: Value from executing hostname on the compute node.
12873           required: true
12874           type: string
12875           example: __HOSTNAME__
12876         - name: interface-name
12877           in: path
12878           description: Name that identifies the link aggregate interface
12879           required: true
12880           type: string
12881           example: __INTERFACE-NAME__
12882   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
12883     put:
12884       tags:
12885         - CloudInfrastructure
12886       summary: see node definition for valid relationships
12887       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12888       consumes:
12889         - application/json
12890         - application/xml
12891       produces:
12892         - application/json
12893         - application/xml
12894       responses:
12895         "default":
12896           description: Response codes found in [response codes](https://wiki.onap.org/).
12897       parameters:
12898         - name: hostname
12899           in: path
12900           description: Value from executing hostname on the compute node.
12901           required: true
12902           type: string
12903           example: __HOSTNAME__
12904         - name: interface-name
12905           in: path
12906           description: Name that identifies the link aggregate interface
12907           required: true
12908           type: string
12909           example: __INTERFACE-NAME__
12910         - name: interface-name
12911           in: path
12912           description: Name given to the interface
12913           required: true
12914           type: string
12915           example: __INTERFACE-NAME__
12916         - name: vlan-interface
12917           in: path
12918           description: String that identifies the interface
12919           required: true
12920           type: string
12921           example: __VLAN-INTERFACE__
12922         - name: body
12923           in: body
12924           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12925           required: true
12926           schema:
12927             $ref: "#/definitions/relationship"
12928     delete:
12929       tags:
12930         - CloudInfrastructure
12931       summary: delete an existing relationship
12932       description: delete an existing relationship
12933       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12934       consumes:
12935         - application/json
12936         - application/xml
12937       produces:
12938         - application/json
12939         - application/xml
12940       responses:
12941         "default":
12942           description: Response codes found in [response codes](https://wiki.onap.org/).
12943       parameters:
12944         - name: hostname
12945           in: path
12946           description: Value from executing hostname on the compute node.
12947           required: true
12948           type: string
12949           example: __HOSTNAME__
12950         - name: interface-name
12951           in: path
12952           description: Name that identifies the link aggregate interface
12953           required: true
12954           type: string
12955           example: __INTERFACE-NAME__
12956         - name: interface-name
12957           in: path
12958           description: Name given to the interface
12959           required: true
12960           type: string
12961           example: __INTERFACE-NAME__
12962         - name: vlan-interface
12963           in: path
12964           description: String that identifies the interface
12965           required: true
12966           type: string
12967           example: __VLAN-INTERFACE__
12968   /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:
12969     put:
12970       tags:
12971         - CloudInfrastructure
12972       summary: see node definition for valid relationships
12973       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
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: vlan-interface
13003           in: path
13004           description: String that identifies the interface
13005           required: true
13006           type: string
13007           example: __VLAN-INTERFACE__
13008         - name: l3-interface-ipv4-address
13009           in: path
13010           description: IP address
13011           required: true
13012           type: string
13013           example: __L3-INTERFACE-IPV4-ADDRESS__
13014         - name: body
13015           in: body
13016           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
13017           required: true
13018           schema:
13019             $ref: "#/definitions/relationship"
13020     delete:
13021       tags:
13022         - CloudInfrastructure
13023       summary: delete an existing relationship
13024       description: delete an existing relationship
13025       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
13026       consumes:
13027         - application/json
13028         - application/xml
13029       produces:
13030         - application/json
13031         - application/xml
13032       responses:
13033         "default":
13034           description: Response codes found in [response codes](https://wiki.onap.org/).
13035       parameters:
13036         - name: hostname
13037           in: path
13038           description: Value from executing hostname on the compute node.
13039           required: true
13040           type: string
13041           example: __HOSTNAME__
13042         - name: interface-name
13043           in: path
13044           description: Name that identifies the link aggregate interface
13045           required: true
13046           type: string
13047           example: __INTERFACE-NAME__
13048         - name: interface-name
13049           in: path
13050           description: Name given to the interface
13051           required: true
13052           type: string
13053           example: __INTERFACE-NAME__
13054         - name: vlan-interface
13055           in: path
13056           description: String that identifies the interface
13057           required: true
13058           type: string
13059           example: __VLAN-INTERFACE__
13060         - name: l3-interface-ipv4-address
13061           in: path
13062           description: IP address
13063           required: true
13064           type: string
13065           example: __L3-INTERFACE-IPV4-ADDRESS__
13066   /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}:
13067     get:
13068       tags:
13069         - CloudInfrastructure
13070       summary: returns l3-interface-ipv4-address-list
13071       description: returns l3-interface-ipv4-address-list
13072       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13073       produces:
13074         - application/json
13075         - application/xml
13076       responses:
13077         "200":
13078           description: successful operation
13079           schema:
13080               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13081         "default":
13082           description: Response codes found in [response codes](https://wiki.onap.org/).
13083       parameters:
13084         - name: hostname
13085           in: path
13086           description: Value from executing hostname on the compute node.
13087           required: true
13088           type: string
13089           example: __HOSTNAME__
13090         - name: interface-name
13091           in: path
13092           description: Name that identifies the link aggregate interface
13093           required: true
13094           type: string
13095           example: __INTERFACE-NAME__
13096         - name: interface-name
13097           in: path
13098           description: Name given to the interface
13099           required: true
13100           type: string
13101           example: __INTERFACE-NAME__
13102         - name: vlan-interface
13103           in: path
13104           description: String that identifies the interface
13105           required: true
13106           type: string
13107           example: __VLAN-INTERFACE__
13108         - name: l3-interface-ipv4-address
13109           in: path
13110           description: IP address
13111           required: true
13112           type: string
13113           example: __L3-INTERFACE-IPV4-ADDRESS__
13114         - name: inv-status
13115           in: query
13116           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13117           required: false
13118           type: string
13119         - name: pserver-id
13120           in: query
13121           description: ID of Pserver
13122           required: false
13123           type: string
13124         - name: in-maint
13125           in: query
13126           required: false
13127           type: boolean
13128         - name: pserver-name2
13129           in: query
13130           description: alternative pserver name
13131           required: false
13132           type: string
13133         - name: interface-id
13134           in: query
13135           description: ID of interface
13136           required: false
13137           type: string
13138         - name: interface-role
13139           in: query
13140           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13141           required: false
13142           type: string
13143         - name: interface-id
13144           in: query
13145           description: ID of interface
13146           required: false
13147           type: string
13148         - name: macaddr
13149           in: query
13150           description: MAC address for the interface
13151           required: false
13152           type: string
13153         - name: network-name
13154           in: query
13155           description: Name of the network
13156           required: false
13157           type: string
13158         - name: vlan-id-inner
13159           in: query
13160           description: Inner VLAN tag
13161           required: false
13162           type: integer
13163           format: int64
13164         - name: vpn-key
13165           in: query
13166           description: This indicates the customers VPN ID associated with this vlan
13167           required: false
13168           type: string
13169         - name: vlan-id-inner
13170           in: query
13171           description: Inner VLAN tag
13172           required: false
13173           type: integer
13174           format: int64
13175         - name: neutron-network-id
13176           in: query
13177           description: Neutron network id of the interface that address belongs to
13178           required: false
13179           type: string
13180         - name: neutron-subnet-id
13181           in: query
13182           description: Neutron id of subnet that address belongs to
13183           required: false
13184           type: string
13185     put:
13186       tags:
13187         - CloudInfrastructure
13188       summary: create or update an existing l3-interface-ipv4-address-list
13189       description: |
13190         Create or update an existing l3-interface-ipv4-address-list.
13191         #
13192         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
13193       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13194       consumes:
13195         - application/json
13196         - application/xml
13197       produces:
13198         - application/json
13199         - application/xml
13200       responses:
13201         "default":
13202           description: Response codes found in [response codes](https://wiki.onap.org/).
13203       parameters:
13204         - name: hostname
13205           in: path
13206           description: Value from executing hostname on the compute node.
13207           required: true
13208           type: string
13209           example: __HOSTNAME__
13210         - name: interface-name
13211           in: path
13212           description: Name that identifies the link aggregate interface
13213           required: true
13214           type: string
13215           example: __INTERFACE-NAME__
13216         - name: interface-name
13217           in: path
13218           description: Name given to the interface
13219           required: true
13220           type: string
13221           example: __INTERFACE-NAME__
13222         - name: vlan-interface
13223           in: path
13224           description: String that identifies the interface
13225           required: true
13226           type: string
13227           example: __VLAN-INTERFACE__
13228         - name: l3-interface-ipv4-address
13229           in: path
13230           description: IP address
13231           required: true
13232           type: string
13233           example: __L3-INTERFACE-IPV4-ADDRESS__
13234         - name: body
13235           in: body
13236           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
13237           required: true
13238           schema:
13239             $ref: "#/definitions/l3-interface-ipv4-address-list"
13240     patch:
13241       tags:
13242         - CloudInfrastructure
13243       summary: update an existing l3-interface-ipv4-address-list
13244       description: |
13245         Update an existing l3-interface-ipv4-address-list
13246         #
13247         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13248         The PUT operation will entirely replace an existing object.
13249         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.
13250         #
13251         Other differences between PUT and PATCH are:
13252         #
13253         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13254         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13255         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13256       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13257       consumes:
13258         - application/json
13259         - application/xml
13260       produces:
13261         - application/json
13262         - application/xml
13263       responses:
13264         "default":
13265           description: Response codes found in [response codes](https://wiki.onap.org/).
13266       parameters:
13267         - name: hostname
13268           in: path
13269           description: Value from executing hostname on the compute node.
13270           required: true
13271           type: string
13272           example: __HOSTNAME__
13273         - name: interface-name
13274           in: path
13275           description: Name that identifies the link aggregate interface
13276           required: true
13277           type: string
13278           example: __INTERFACE-NAME__
13279         - name: interface-name
13280           in: path
13281           description: Name given to the interface
13282           required: true
13283           type: string
13284           example: __INTERFACE-NAME__
13285         - name: vlan-interface
13286           in: path
13287           description: String that identifies the interface
13288           required: true
13289           type: string
13290           example: __VLAN-INTERFACE__
13291         - name: l3-interface-ipv4-address
13292           in: path
13293           description: IP address
13294           required: true
13295           type: string
13296           example: __L3-INTERFACE-IPV4-ADDRESS__
13297         - name: body
13298           in: body
13299           description: l3-interface-ipv4-address-list object that needs to be created or updated.
13300           required: true
13301           schema:
13302             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13303     delete:
13304       tags:
13305         - CloudInfrastructure
13306       summary: delete an existing l3-interface-ipv4-address-list
13307       description: delete an existing l3-interface-ipv4-address-list
13308       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
13309       consumes:
13310         - application/json
13311         - application/xml
13312       produces:
13313         - application/json
13314         - application/xml
13315       responses:
13316         "default":
13317           description: Response codes found in [response codes](https://wiki.onap.org/).
13318       parameters:
13319         - name: hostname
13320           in: path
13321           description: Value from executing hostname on the compute node.
13322           required: true
13323           type: string
13324           example: __HOSTNAME__
13325         - name: interface-name
13326           in: path
13327           description: Name that identifies the link aggregate interface
13328           required: true
13329           type: string
13330           example: __INTERFACE-NAME__
13331         - name: interface-name
13332           in: path
13333           description: Name given to the interface
13334           required: true
13335           type: string
13336           example: __INTERFACE-NAME__
13337         - name: vlan-interface
13338           in: path
13339           description: String that identifies the interface
13340           required: true
13341           type: string
13342           example: __VLAN-INTERFACE__
13343         - name: l3-interface-ipv4-address
13344           in: path
13345           description: IP address
13346           required: true
13347           type: string
13348           example: __L3-INTERFACE-IPV4-ADDRESS__
13349         - name: resource-version
13350           in: query
13351           description: resource-version for concurrency
13352           required: true
13353           type: string
13354   /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:
13355     put:
13356       tags:
13357         - CloudInfrastructure
13358       summary: see node definition for valid relationships
13359       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
13360       consumes:
13361         - application/json
13362         - application/xml
13363       produces:
13364         - application/json
13365         - application/xml
13366       responses:
13367         "default":
13368           description: Response codes found in [response codes](https://wiki.onap.org/).
13369       parameters:
13370         - name: hostname
13371           in: path
13372           description: Value from executing hostname on the compute node.
13373           required: true
13374           type: string
13375           example: __HOSTNAME__
13376         - name: interface-name
13377           in: path
13378           description: Name that identifies the link aggregate interface
13379           required: true
13380           type: string
13381           example: __INTERFACE-NAME__
13382         - name: interface-name
13383           in: path
13384           description: Name given to the interface
13385           required: true
13386           type: string
13387           example: __INTERFACE-NAME__
13388         - name: vlan-interface
13389           in: path
13390           description: String that identifies the interface
13391           required: true
13392           type: string
13393           example: __VLAN-INTERFACE__
13394         - name: l3-interface-ipv6-address
13395           in: path
13396           description: IP address
13397           required: true
13398           type: string
13399           example: __L3-INTERFACE-IPV6-ADDRESS__
13400         - name: body
13401           in: body
13402           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
13403           required: true
13404           schema:
13405             $ref: "#/definitions/relationship"
13406     delete:
13407       tags:
13408         - CloudInfrastructure
13409       summary: delete an existing relationship
13410       description: delete an existing relationship
13411       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
13412       consumes:
13413         - application/json
13414         - application/xml
13415       produces:
13416         - application/json
13417         - application/xml
13418       responses:
13419         "default":
13420           description: Response codes found in [response codes](https://wiki.onap.org/).
13421       parameters:
13422         - name: hostname
13423           in: path
13424           description: Value from executing hostname on the compute node.
13425           required: true
13426           type: string
13427           example: __HOSTNAME__
13428         - name: interface-name
13429           in: path
13430           description: Name that identifies the link aggregate interface
13431           required: true
13432           type: string
13433           example: __INTERFACE-NAME__
13434         - name: interface-name
13435           in: path
13436           description: Name given to the interface
13437           required: true
13438           type: string
13439           example: __INTERFACE-NAME__
13440         - name: vlan-interface
13441           in: path
13442           description: String that identifies the interface
13443           required: true
13444           type: string
13445           example: __VLAN-INTERFACE__
13446         - name: l3-interface-ipv6-address
13447           in: path
13448           description: IP address
13449           required: true
13450           type: string
13451           example: __L3-INTERFACE-IPV6-ADDRESS__
13452   /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}:
13453     get:
13454       tags:
13455         - CloudInfrastructure
13456       summary: returns l3-interface-ipv6-address-list
13457       description: returns l3-interface-ipv6-address-list
13458       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13459       produces:
13460         - application/json
13461         - application/xml
13462       responses:
13463         "200":
13464           description: successful operation
13465           schema:
13466               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13467         "default":
13468           description: Response codes found in [response codes](https://wiki.onap.org/).
13469       parameters:
13470         - name: hostname
13471           in: path
13472           description: Value from executing hostname on the compute node.
13473           required: true
13474           type: string
13475           example: __HOSTNAME__
13476         - name: interface-name
13477           in: path
13478           description: Name that identifies the link aggregate interface
13479           required: true
13480           type: string
13481           example: __INTERFACE-NAME__
13482         - name: interface-name
13483           in: path
13484           description: Name given to the interface
13485           required: true
13486           type: string
13487           example: __INTERFACE-NAME__
13488         - name: vlan-interface
13489           in: path
13490           description: String that identifies the interface
13491           required: true
13492           type: string
13493           example: __VLAN-INTERFACE__
13494         - name: l3-interface-ipv6-address
13495           in: path
13496           description: IP address
13497           required: true
13498           type: string
13499           example: __L3-INTERFACE-IPV6-ADDRESS__
13500         - name: inv-status
13501           in: query
13502           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13503           required: false
13504           type: string
13505         - name: pserver-id
13506           in: query
13507           description: ID of Pserver
13508           required: false
13509           type: string
13510         - name: in-maint
13511           in: query
13512           required: false
13513           type: boolean
13514         - name: pserver-name2
13515           in: query
13516           description: alternative pserver name
13517           required: false
13518           type: string
13519         - name: interface-id
13520           in: query
13521           description: ID of interface
13522           required: false
13523           type: string
13524         - name: interface-role
13525           in: query
13526           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13527           required: false
13528           type: string
13529         - name: interface-id
13530           in: query
13531           description: ID of interface
13532           required: false
13533           type: string
13534         - name: macaddr
13535           in: query
13536           description: MAC address for the interface
13537           required: false
13538           type: string
13539         - name: network-name
13540           in: query
13541           description: Name of the network
13542           required: false
13543           type: string
13544         - name: vlan-id-inner
13545           in: query
13546           description: Inner VLAN tag
13547           required: false
13548           type: integer
13549           format: int64
13550         - name: vpn-key
13551           in: query
13552           description: This indicates the customers VPN ID associated with this vlan
13553           required: false
13554           type: string
13555         - name: vlan-id-inner
13556           in: query
13557           description: Inner VLAN tag
13558           required: false
13559           type: integer
13560           format: int64
13561         - name: neutron-network-id
13562           in: query
13563           description: Neutron network id of the interface that address belongs to
13564           required: false
13565           type: string
13566         - name: neutron-subnet-id
13567           in: query
13568           description: Neutron id of subnet that address belongs to
13569           required: false
13570           type: string
13571     put:
13572       tags:
13573         - CloudInfrastructure
13574       summary: create or update an existing l3-interface-ipv6-address-list
13575       description: |
13576         Create or update an existing l3-interface-ipv6-address-list.
13577         #
13578         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
13579       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13580       consumes:
13581         - application/json
13582         - application/xml
13583       produces:
13584         - application/json
13585         - application/xml
13586       responses:
13587         "default":
13588           description: Response codes found in [response codes](https://wiki.onap.org/).
13589       parameters:
13590         - name: hostname
13591           in: path
13592           description: Value from executing hostname on the compute node.
13593           required: true
13594           type: string
13595           example: __HOSTNAME__
13596         - name: interface-name
13597           in: path
13598           description: Name that identifies the link aggregate interface
13599           required: true
13600           type: string
13601           example: __INTERFACE-NAME__
13602         - name: interface-name
13603           in: path
13604           description: Name given to the interface
13605           required: true
13606           type: string
13607           example: __INTERFACE-NAME__
13608         - name: vlan-interface
13609           in: path
13610           description: String that identifies the interface
13611           required: true
13612           type: string
13613           example: __VLAN-INTERFACE__
13614         - name: l3-interface-ipv6-address
13615           in: path
13616           description: IP address
13617           required: true
13618           type: string
13619           example: __L3-INTERFACE-IPV6-ADDRESS__
13620         - name: body
13621           in: body
13622           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
13623           required: true
13624           schema:
13625             $ref: "#/definitions/l3-interface-ipv6-address-list"
13626     patch:
13627       tags:
13628         - CloudInfrastructure
13629       summary: update an existing l3-interface-ipv6-address-list
13630       description: |
13631         Update an existing l3-interface-ipv6-address-list
13632         #
13633         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13634         The PUT operation will entirely replace an existing object.
13635         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.
13636         #
13637         Other differences between PUT and PATCH are:
13638         #
13639         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13640         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13641         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13642       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13643       consumes:
13644         - application/json
13645         - application/xml
13646       produces:
13647         - application/json
13648         - application/xml
13649       responses:
13650         "default":
13651           description: Response codes found in [response codes](https://wiki.onap.org/).
13652       parameters:
13653         - name: hostname
13654           in: path
13655           description: Value from executing hostname on the compute node.
13656           required: true
13657           type: string
13658           example: __HOSTNAME__
13659         - name: interface-name
13660           in: path
13661           description: Name that identifies the link aggregate interface
13662           required: true
13663           type: string
13664           example: __INTERFACE-NAME__
13665         - name: interface-name
13666           in: path
13667           description: Name given to the interface
13668           required: true
13669           type: string
13670           example: __INTERFACE-NAME__
13671         - name: vlan-interface
13672           in: path
13673           description: String that identifies the interface
13674           required: true
13675           type: string
13676           example: __VLAN-INTERFACE__
13677         - name: l3-interface-ipv6-address
13678           in: path
13679           description: IP address
13680           required: true
13681           type: string
13682           example: __L3-INTERFACE-IPV6-ADDRESS__
13683         - name: body
13684           in: body
13685           description: l3-interface-ipv6-address-list object that needs to be created or updated.
13686           required: true
13687           schema:
13688             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13689     delete:
13690       tags:
13691         - CloudInfrastructure
13692       summary: delete an existing l3-interface-ipv6-address-list
13693       description: delete an existing l3-interface-ipv6-address-list
13694       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13695       consumes:
13696         - application/json
13697         - application/xml
13698       produces:
13699         - application/json
13700         - application/xml
13701       responses:
13702         "default":
13703           description: Response codes found in [response codes](https://wiki.onap.org/).
13704       parameters:
13705         - name: hostname
13706           in: path
13707           description: Value from executing hostname on the compute node.
13708           required: true
13709           type: string
13710           example: __HOSTNAME__
13711         - name: interface-name
13712           in: path
13713           description: Name that identifies the link aggregate interface
13714           required: true
13715           type: string
13716           example: __INTERFACE-NAME__
13717         - name: interface-name
13718           in: path
13719           description: Name given to the interface
13720           required: true
13721           type: string
13722           example: __INTERFACE-NAME__
13723         - name: vlan-interface
13724           in: path
13725           description: String that identifies the interface
13726           required: true
13727           type: string
13728           example: __VLAN-INTERFACE__
13729         - name: l3-interface-ipv6-address
13730           in: path
13731           description: IP address
13732           required: true
13733           type: string
13734           example: __L3-INTERFACE-IPV6-ADDRESS__
13735         - name: resource-version
13736           in: query
13737           description: resource-version for concurrency
13738           required: true
13739           type: string
13740   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
13741     get:
13742       tags:
13743         - CloudInfrastructure
13744       summary: returns vlan
13745       description: returns vlan
13746       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13747       produces:
13748         - application/json
13749         - application/xml
13750       responses:
13751         "200":
13752           description: successful operation
13753           schema:
13754               $ref: "#/getDefinitions/vlan"
13755         "default":
13756           description: Response codes found in [response codes](https://wiki.onap.org/).
13757       parameters:
13758         - name: hostname
13759           in: path
13760           description: Value from executing hostname on the compute node.
13761           required: true
13762           type: string
13763           example: __HOSTNAME__
13764         - name: interface-name
13765           in: path
13766           description: Name that identifies the link aggregate interface
13767           required: true
13768           type: string
13769           example: __INTERFACE-NAME__
13770         - name: interface-name
13771           in: path
13772           description: Name given to the interface
13773           required: true
13774           type: string
13775           example: __INTERFACE-NAME__
13776         - name: vlan-interface
13777           in: path
13778           description: String that identifies the interface
13779           required: true
13780           type: string
13781           example: __VLAN-INTERFACE__
13782         - name: inv-status
13783           in: query
13784           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13785           required: false
13786           type: string
13787         - name: pserver-id
13788           in: query
13789           description: ID of Pserver
13790           required: false
13791           type: string
13792         - name: in-maint
13793           in: query
13794           required: false
13795           type: boolean
13796         - name: pserver-name2
13797           in: query
13798           description: alternative pserver name
13799           required: false
13800           type: string
13801         - name: interface-id
13802           in: query
13803           description: ID of interface
13804           required: false
13805           type: string
13806         - name: interface-role
13807           in: query
13808           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13809           required: false
13810           type: string
13811         - name: interface-id
13812           in: query
13813           description: ID of interface
13814           required: false
13815           type: string
13816         - name: macaddr
13817           in: query
13818           description: MAC address for the interface
13819           required: false
13820           type: string
13821         - name: network-name
13822           in: query
13823           description: Name of the network
13824           required: false
13825           type: string
13826         - name: vlan-id-inner
13827           in: query
13828           description: Inner VLAN tag
13829           required: false
13830           type: integer
13831           format: int64
13832         - name: vpn-key
13833           in: query
13834           description: This indicates the customers VPN ID associated with this vlan
13835           required: false
13836           type: string
13837     put:
13838       tags:
13839         - CloudInfrastructure
13840       summary: create or update an existing vlan
13841       description: |
13842         Create or update an existing vlan.
13843         #
13844         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
13845       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13846       consumes:
13847         - application/json
13848         - application/xml
13849       produces:
13850         - application/json
13851         - application/xml
13852       responses:
13853         "default":
13854           description: Response codes found in [response codes](https://wiki.onap.org/).
13855       parameters:
13856         - name: hostname
13857           in: path
13858           description: Value from executing hostname on the compute node.
13859           required: true
13860           type: string
13861           example: __HOSTNAME__
13862         - name: interface-name
13863           in: path
13864           description: Name that identifies the link aggregate interface
13865           required: true
13866           type: string
13867           example: __INTERFACE-NAME__
13868         - name: interface-name
13869           in: path
13870           description: Name given to the interface
13871           required: true
13872           type: string
13873           example: __INTERFACE-NAME__
13874         - name: vlan-interface
13875           in: path
13876           description: String that identifies the interface
13877           required: true
13878           type: string
13879           example: __VLAN-INTERFACE__
13880         - name: body
13881           in: body
13882           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
13883           required: true
13884           schema:
13885             $ref: "#/definitions/vlan"
13886     patch:
13887       tags:
13888         - CloudInfrastructure
13889       summary: update an existing vlan
13890       description: |
13891         Update an existing vlan
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: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
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: interface-name
13926           in: path
13927           description: Name given to the interface
13928           required: true
13929           type: string
13930           example: __INTERFACE-NAME__
13931         - name: vlan-interface
13932           in: path
13933           description: String that identifies the interface
13934           required: true
13935           type: string
13936           example: __VLAN-INTERFACE__
13937         - name: body
13938           in: body
13939           description: vlan object that needs to be created or updated.
13940           required: true
13941           schema:
13942             $ref: "#/patchDefinitions/vlan"
13943     delete:
13944       tags:
13945         - CloudInfrastructure
13946       summary: delete an existing vlan
13947       description: delete an existing vlan
13948       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13949       consumes:
13950         - application/json
13951         - application/xml
13952       produces:
13953         - application/json
13954         - application/xml
13955       responses:
13956         "default":
13957           description: Response codes found in [response codes](https://wiki.onap.org/).
13958       parameters:
13959         - name: hostname
13960           in: path
13961           description: Value from executing hostname on the compute node.
13962           required: true
13963           type: string
13964           example: __HOSTNAME__
13965         - name: interface-name
13966           in: path
13967           description: Name that identifies the link aggregate interface
13968           required: true
13969           type: string
13970           example: __INTERFACE-NAME__
13971         - name: interface-name
13972           in: path
13973           description: Name given to the interface
13974           required: true
13975           type: string
13976           example: __INTERFACE-NAME__
13977         - name: vlan-interface
13978           in: path
13979           description: String that identifies the interface
13980           required: true
13981           type: string
13982           example: __VLAN-INTERFACE__
13983         - name: resource-version
13984           in: query
13985           description: resource-version for concurrency
13986           required: true
13987           type: string
13988   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
13989     get:
13990       tags:
13991         - CloudInfrastructure
13992       summary: returns vlans
13993       description: returns vlans
13994       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
13995       produces:
13996         - application/json
13997         - application/xml
13998       responses:
13999         "200":
14000           description: successful operation
14001           schema:
14002               $ref: "#/getDefinitions/vlans"
14003         "default":
14004           description: Response codes found in [response codes](https://wiki.onap.org/).
14005       parameters:
14006         - name: hostname
14007           in: path
14008           description: Value from executing hostname on the compute node.
14009           required: true
14010           type: string
14011           example: __HOSTNAME__
14012         - name: interface-name
14013           in: path
14014           description: Name that identifies the link aggregate interface
14015           required: true
14016           type: string
14017           example: __INTERFACE-NAME__
14018         - name: interface-name
14019           in: path
14020           description: Name given to the interface
14021           required: true
14022           type: string
14023           example: __INTERFACE-NAME__
14024         - name: inv-status
14025           in: query
14026           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14027           required: false
14028           type: string
14029         - name: pserver-id
14030           in: query
14031           description: ID of Pserver
14032           required: false
14033           type: string
14034         - name: in-maint
14035           in: query
14036           required: false
14037           type: boolean
14038         - name: pserver-name2
14039           in: query
14040           description: alternative pserver name
14041           required: false
14042           type: string
14043         - name: interface-id
14044           in: query
14045           description: ID of interface
14046           required: false
14047           type: string
14048         - name: interface-role
14049           in: query
14050           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14051           required: false
14052           type: string
14053         - name: interface-id
14054           in: query
14055           description: ID of interface
14056           required: false
14057           type: string
14058         - name: macaddr
14059           in: query
14060           description: MAC address for the interface
14061           required: false
14062           type: string
14063         - name: network-name
14064           in: query
14065           description: Name of the network
14066           required: false
14067           type: string
14068   /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:
14069     put:
14070       tags:
14071         - CloudInfrastructure
14072       summary: see node definition for valid relationships
14073       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
14074       consumes:
14075         - application/json
14076         - application/xml
14077       produces:
14078         - application/json
14079         - application/xml
14080       responses:
14081         "default":
14082           description: Response codes found in [response codes](https://wiki.onap.org/).
14083       parameters:
14084         - name: hostname
14085           in: path
14086           description: Value from executing hostname on the compute node.
14087           required: true
14088           type: string
14089           example: __HOSTNAME__
14090         - name: interface-name
14091           in: path
14092           description: Name that identifies the link aggregate interface
14093           required: true
14094           type: string
14095           example: __INTERFACE-NAME__
14096         - name: interface-name
14097           in: path
14098           description: Name given to the interface
14099           required: true
14100           type: string
14101           example: __INTERFACE-NAME__
14102         - name: pci-id
14103           in: path
14104           description: PCI ID used to identify the sriov-vf
14105           required: true
14106           type: string
14107           example: __PCI-ID__
14108         - name: body
14109           in: body
14110           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
14111           required: true
14112           schema:
14113             $ref: "#/definitions/relationship"
14114     delete:
14115       tags:
14116         - CloudInfrastructure
14117       summary: delete an existing relationship
14118       description: delete an existing relationship
14119       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
14120       consumes:
14121         - application/json
14122         - application/xml
14123       produces:
14124         - application/json
14125         - application/xml
14126       responses:
14127         "default":
14128           description: Response codes found in [response codes](https://wiki.onap.org/).
14129       parameters:
14130         - name: hostname
14131           in: path
14132           description: Value from executing hostname on the compute node.
14133           required: true
14134           type: string
14135           example: __HOSTNAME__
14136         - name: interface-name
14137           in: path
14138           description: Name that identifies the link aggregate interface
14139           required: true
14140           type: string
14141           example: __INTERFACE-NAME__
14142         - name: interface-name
14143           in: path
14144           description: Name given to the interface
14145           required: true
14146           type: string
14147           example: __INTERFACE-NAME__
14148         - name: pci-id
14149           in: path
14150           description: PCI ID used to identify the sriov-vf
14151           required: true
14152           type: string
14153           example: __PCI-ID__
14154   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
14155     get:
14156       tags:
14157         - CloudInfrastructure
14158       summary: returns sriov-vf
14159       description: returns sriov-vf
14160       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14161       produces:
14162         - application/json
14163         - application/xml
14164       responses:
14165         "200":
14166           description: successful operation
14167           schema:
14168               $ref: "#/getDefinitions/sriov-vf"
14169         "default":
14170           description: Response codes found in [response codes](https://wiki.onap.org/).
14171       parameters:
14172         - name: hostname
14173           in: path
14174           description: Value from executing hostname on the compute node.
14175           required: true
14176           type: string
14177           example: __HOSTNAME__
14178         - name: interface-name
14179           in: path
14180           description: Name that identifies the link aggregate interface
14181           required: true
14182           type: string
14183           example: __INTERFACE-NAME__
14184         - name: interface-name
14185           in: path
14186           description: Name given to the interface
14187           required: true
14188           type: string
14189           example: __INTERFACE-NAME__
14190         - name: pci-id
14191           in: path
14192           description: PCI ID used to identify the sriov-vf
14193           required: true
14194           type: string
14195           example: __PCI-ID__
14196         - name: inv-status
14197           in: query
14198           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14199           required: false
14200           type: string
14201         - name: pserver-id
14202           in: query
14203           description: ID of Pserver
14204           required: false
14205           type: string
14206         - name: in-maint
14207           in: query
14208           required: false
14209           type: boolean
14210         - name: pserver-name2
14211           in: query
14212           description: alternative pserver name
14213           required: false
14214           type: string
14215         - name: interface-id
14216           in: query
14217           description: ID of interface
14218           required: false
14219           type: string
14220         - name: interface-role
14221           in: query
14222           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14223           required: false
14224           type: string
14225         - name: interface-id
14226           in: query
14227           description: ID of interface
14228           required: false
14229           type: string
14230         - name: macaddr
14231           in: query
14232           description: MAC address for the interface
14233           required: false
14234           type: string
14235         - name: network-name
14236           in: query
14237           description: Name of the network
14238           required: false
14239           type: string
14240         - name: vf-vlan-filter
14241           in: query
14242           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
14243           required: false
14244           type: string
14245         - name: vf-mac-filter
14246           in: query
14247           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
14248           required: false
14249           type: string
14250         - name: vf-vlan-strip
14251           in: query
14252           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
14253           required: false
14254           type: boolean
14255         - name: neutron-network-id
14256           in: query
14257           description: Neutron network id of the interface
14258           required: false
14259           type: string
14260     put:
14261       tags:
14262         - CloudInfrastructure
14263       summary: create or update an existing sriov-vf
14264       description: |
14265         Create or update an existing sriov-vf.
14266         #
14267         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
14268       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14269       consumes:
14270         - application/json
14271         - application/xml
14272       produces:
14273         - application/json
14274         - application/xml
14275       responses:
14276         "default":
14277           description: Response codes found in [response codes](https://wiki.onap.org/).
14278       parameters:
14279         - name: hostname
14280           in: path
14281           description: Value from executing hostname on the compute node.
14282           required: true
14283           type: string
14284           example: __HOSTNAME__
14285         - name: interface-name
14286           in: path
14287           description: Name that identifies the link aggregate interface
14288           required: true
14289           type: string
14290           example: __INTERFACE-NAME__
14291         - name: interface-name
14292           in: path
14293           description: Name given to the interface
14294           required: true
14295           type: string
14296           example: __INTERFACE-NAME__
14297         - name: pci-id
14298           in: path
14299           description: PCI ID used to identify the sriov-vf
14300           required: true
14301           type: string
14302           example: __PCI-ID__
14303         - name: body
14304           in: body
14305           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
14306           required: true
14307           schema:
14308             $ref: "#/definitions/sriov-vf"
14309     patch:
14310       tags:
14311         - CloudInfrastructure
14312       summary: update an existing sriov-vf
14313       description: |
14314         Update an existing sriov-vf
14315         #
14316         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14317         The PUT operation will entirely replace an existing object.
14318         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.
14319         #
14320         Other differences between PUT and PATCH are:
14321         #
14322         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14323         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14324         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14325       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
14326       consumes:
14327         - application/json
14328         - application/xml
14329       produces:
14330         - application/json
14331         - application/xml
14332       responses:
14333         "default":
14334           description: Response codes found in [response codes](https://wiki.onap.org/).
14335       parameters:
14336         - name: hostname
14337           in: path
14338           description: Value from executing hostname on the compute node.
14339           required: true
14340           type: string
14341           example: __HOSTNAME__
14342         - name: interface-name
14343           in: path
14344           description: Name that identifies the link aggregate interface
14345           required: true
14346           type: string
14347           example: __INTERFACE-NAME__
14348         - name: interface-name
14349           in: path
14350           description: Name given to the interface
14351           required: true
14352           type: string
14353           example: __INTERFACE-NAME__
14354         - name: pci-id
14355           in: path
14356           description: PCI ID used to identify the sriov-vf
14357           required: true
14358           type: string
14359           example: __PCI-ID__
14360         - name: body
14361           in: body
14362           description: sriov-vf object that needs to be created or updated.
14363           required: true
14364           schema:
14365             $ref: "#/patchDefinitions/sriov-vf"
14366     delete:
14367       tags:
14368         - CloudInfrastructure
14369       summary: delete an existing sriov-vf
14370       description: delete an existing sriov-vf
14371       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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: hostname
14383           in: path
14384           description: Value from executing hostname on the compute node.
14385           required: true
14386           type: string
14387           example: __HOSTNAME__
14388         - name: interface-name
14389           in: path
14390           description: Name that identifies the link aggregate interface
14391           required: true
14392           type: string
14393           example: __INTERFACE-NAME__
14394         - name: interface-name
14395           in: path
14396           description: Name given to the interface
14397           required: true
14398           type: string
14399           example: __INTERFACE-NAME__
14400         - name: pci-id
14401           in: path
14402           description: PCI ID used to identify the sriov-vf
14403           required: true
14404           type: string
14405           example: __PCI-ID__
14406         - name: resource-version
14407           in: query
14408           description: resource-version for concurrency
14409           required: true
14410           type: string
14411   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
14412     get:
14413       tags:
14414         - CloudInfrastructure
14415       summary: returns sriov-vfs
14416       description: returns sriov-vfs
14417       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
14418       produces:
14419         - application/json
14420         - application/xml
14421       responses:
14422         "200":
14423           description: successful operation
14424           schema:
14425               $ref: "#/getDefinitions/sriov-vfs"
14426         "default":
14427           description: Response codes found in [response codes](https://wiki.onap.org/).
14428       parameters:
14429         - name: hostname
14430           in: path
14431           description: Value from executing hostname on the compute node.
14432           required: true
14433           type: string
14434           example: __HOSTNAME__
14435         - name: interface-name
14436           in: path
14437           description: Name that identifies the link aggregate interface
14438           required: true
14439           type: string
14440           example: __INTERFACE-NAME__
14441         - name: interface-name
14442           in: path
14443           description: Name given to the interface
14444           required: true
14445           type: string
14446           example: __INTERFACE-NAME__
14447         - name: inv-status
14448           in: query
14449           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14450           required: false
14451           type: string
14452         - name: pserver-id
14453           in: query
14454           description: ID of Pserver
14455           required: false
14456           type: string
14457         - name: in-maint
14458           in: query
14459           required: false
14460           type: boolean
14461         - name: pserver-name2
14462           in: query
14463           description: alternative pserver name
14464           required: false
14465           type: string
14466         - name: interface-id
14467           in: query
14468           description: ID of interface
14469           required: false
14470           type: string
14471         - name: interface-role
14472           in: query
14473           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14474           required: false
14475           type: string
14476         - name: interface-id
14477           in: query
14478           description: ID of interface
14479           required: false
14480           type: string
14481         - name: macaddr
14482           in: query
14483           description: MAC address for the interface
14484           required: false
14485           type: string
14486         - name: network-name
14487           in: query
14488           description: Name of the network
14489           required: false
14490           type: string
14491   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
14492     put:
14493       tags:
14494         - CloudInfrastructure
14495       summary: see node definition for valid relationships
14496       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
14497       consumes:
14498         - application/json
14499         - application/xml
14500       produces:
14501         - application/json
14502         - application/xml
14503       responses:
14504         "default":
14505           description: Response codes found in [response codes](https://wiki.onap.org/).
14506       parameters:
14507         - name: hostname
14508           in: path
14509           description: Value from executing hostname on the compute node.
14510           required: true
14511           type: string
14512           example: __HOSTNAME__
14513         - name: interface-name
14514           in: path
14515           description: Name that identifies the link aggregate interface
14516           required: true
14517           type: string
14518           example: __INTERFACE-NAME__
14519         - name: interface-name
14520           in: path
14521           description: Name given to the interface
14522           required: true
14523           type: string
14524           example: __INTERFACE-NAME__
14525         - name: body
14526           in: body
14527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
14528           required: true
14529           schema:
14530             $ref: "#/definitions/relationship"
14531     delete:
14532       tags:
14533         - CloudInfrastructure
14534       summary: delete an existing relationship
14535       description: delete an existing relationship
14536       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
14537       consumes:
14538         - application/json
14539         - application/xml
14540       produces:
14541         - application/json
14542         - application/xml
14543       responses:
14544         "default":
14545           description: Response codes found in [response codes](https://wiki.onap.org/).
14546       parameters:
14547         - name: hostname
14548           in: path
14549           description: Value from executing hostname on the compute node.
14550           required: true
14551           type: string
14552           example: __HOSTNAME__
14553         - name: interface-name
14554           in: path
14555           description: Name that identifies the link aggregate interface
14556           required: true
14557           type: string
14558           example: __INTERFACE-NAME__
14559         - name: interface-name
14560           in: path
14561           description: Name given to the interface
14562           required: true
14563           type: string
14564           example: __INTERFACE-NAME__
14565   /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:
14566     put:
14567       tags:
14568         - CloudInfrastructure
14569       summary: see node definition for valid relationships
14570       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
14571       consumes:
14572         - application/json
14573         - application/xml
14574       produces:
14575         - application/json
14576         - application/xml
14577       responses:
14578         "default":
14579           description: Response codes found in [response codes](https://wiki.onap.org/).
14580       parameters:
14581         - name: hostname
14582           in: path
14583           description: Value from executing hostname on the compute node.
14584           required: true
14585           type: string
14586           example: __HOSTNAME__
14587         - name: interface-name
14588           in: path
14589           description: Name that identifies the link aggregate interface
14590           required: true
14591           type: string
14592           example: __INTERFACE-NAME__
14593         - name: interface-name
14594           in: path
14595           description: Name given to the interface
14596           required: true
14597           type: string
14598           example: __INTERFACE-NAME__
14599         - name: l3-interface-ipv4-address
14600           in: path
14601           description: IP address
14602           required: true
14603           type: string
14604           example: __L3-INTERFACE-IPV4-ADDRESS__
14605         - name: body
14606           in: body
14607           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
14608           required: true
14609           schema:
14610             $ref: "#/definitions/relationship"
14611     delete:
14612       tags:
14613         - CloudInfrastructure
14614       summary: delete an existing relationship
14615       description: delete an existing relationship
14616       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
14617       consumes:
14618         - application/json
14619         - application/xml
14620       produces:
14621         - application/json
14622         - application/xml
14623       responses:
14624         "default":
14625           description: Response codes found in [response codes](https://wiki.onap.org/).
14626       parameters:
14627         - name: hostname
14628           in: path
14629           description: Value from executing hostname on the compute node.
14630           required: true
14631           type: string
14632           example: __HOSTNAME__
14633         - name: interface-name
14634           in: path
14635           description: Name that identifies the link aggregate interface
14636           required: true
14637           type: string
14638           example: __INTERFACE-NAME__
14639         - name: interface-name
14640           in: path
14641           description: Name given to the interface
14642           required: true
14643           type: string
14644           example: __INTERFACE-NAME__
14645         - name: l3-interface-ipv4-address
14646           in: path
14647           description: IP address
14648           required: true
14649           type: string
14650           example: __L3-INTERFACE-IPV4-ADDRESS__
14651   /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}:
14652     get:
14653       tags:
14654         - CloudInfrastructure
14655       summary: returns l3-interface-ipv4-address-list
14656       description: returns l3-interface-ipv4-address-list
14657       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14658       produces:
14659         - application/json
14660         - application/xml
14661       responses:
14662         "200":
14663           description: successful operation
14664           schema:
14665               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
14666         "default":
14667           description: Response codes found in [response codes](https://wiki.onap.org/).
14668       parameters:
14669         - name: hostname
14670           in: path
14671           description: Value from executing hostname on the compute node.
14672           required: true
14673           type: string
14674           example: __HOSTNAME__
14675         - name: interface-name
14676           in: path
14677           description: Name that identifies the link aggregate interface
14678           required: true
14679           type: string
14680           example: __INTERFACE-NAME__
14681         - name: interface-name
14682           in: path
14683           description: Name given to the interface
14684           required: true
14685           type: string
14686           example: __INTERFACE-NAME__
14687         - name: l3-interface-ipv4-address
14688           in: path
14689           description: IP address
14690           required: true
14691           type: string
14692           example: __L3-INTERFACE-IPV4-ADDRESS__
14693         - name: inv-status
14694           in: query
14695           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14696           required: false
14697           type: string
14698         - name: pserver-id
14699           in: query
14700           description: ID of Pserver
14701           required: false
14702           type: string
14703         - name: in-maint
14704           in: query
14705           required: false
14706           type: boolean
14707         - name: pserver-name2
14708           in: query
14709           description: alternative pserver name
14710           required: false
14711           type: string
14712         - name: interface-id
14713           in: query
14714           description: ID of interface
14715           required: false
14716           type: string
14717         - name: interface-role
14718           in: query
14719           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14720           required: false
14721           type: string
14722         - name: interface-id
14723           in: query
14724           description: ID of interface
14725           required: false
14726           type: string
14727         - name: macaddr
14728           in: query
14729           description: MAC address for the interface
14730           required: false
14731           type: string
14732         - name: network-name
14733           in: query
14734           description: Name of the network
14735           required: false
14736           type: string
14737         - name: vlan-id-inner
14738           in: query
14739           description: Inner VLAN tag
14740           required: false
14741           type: integer
14742           format: int64
14743         - name: neutron-network-id
14744           in: query
14745           description: Neutron network id of the interface that address belongs to
14746           required: false
14747           type: string
14748         - name: neutron-subnet-id
14749           in: query
14750           description: Neutron id of subnet that address belongs to
14751           required: false
14752           type: string
14753     put:
14754       tags:
14755         - CloudInfrastructure
14756       summary: create or update an existing l3-interface-ipv4-address-list
14757       description: |
14758         Create or update an existing l3-interface-ipv4-address-list.
14759         #
14760         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
14761       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14762       consumes:
14763         - application/json
14764         - application/xml
14765       produces:
14766         - application/json
14767         - application/xml
14768       responses:
14769         "default":
14770           description: Response codes found in [response codes](https://wiki.onap.org/).
14771       parameters:
14772         - name: hostname
14773           in: path
14774           description: Value from executing hostname on the compute node.
14775           required: true
14776           type: string
14777           example: __HOSTNAME__
14778         - name: interface-name
14779           in: path
14780           description: Name that identifies the link aggregate interface
14781           required: true
14782           type: string
14783           example: __INTERFACE-NAME__
14784         - name: interface-name
14785           in: path
14786           description: Name given to the interface
14787           required: true
14788           type: string
14789           example: __INTERFACE-NAME__
14790         - name: l3-interface-ipv4-address
14791           in: path
14792           description: IP address
14793           required: true
14794           type: string
14795           example: __L3-INTERFACE-IPV4-ADDRESS__
14796         - name: body
14797           in: body
14798           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
14799           required: true
14800           schema:
14801             $ref: "#/definitions/l3-interface-ipv4-address-list"
14802     patch:
14803       tags:
14804         - CloudInfrastructure
14805       summary: update an existing l3-interface-ipv4-address-list
14806       description: |
14807         Update an existing l3-interface-ipv4-address-list
14808         #
14809         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14810         The PUT operation will entirely replace an existing object.
14811         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.
14812         #
14813         Other differences between PUT and PATCH are:
14814         #
14815         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14816         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14817         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14818       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14819       consumes:
14820         - application/json
14821         - application/xml
14822       produces:
14823         - application/json
14824         - application/xml
14825       responses:
14826         "default":
14827           description: Response codes found in [response codes](https://wiki.onap.org/).
14828       parameters:
14829         - name: hostname
14830           in: path
14831           description: Value from executing hostname on the compute node.
14832           required: true
14833           type: string
14834           example: __HOSTNAME__
14835         - name: interface-name
14836           in: path
14837           description: Name that identifies the link aggregate interface
14838           required: true
14839           type: string
14840           example: __INTERFACE-NAME__
14841         - name: interface-name
14842           in: path
14843           description: Name given to the interface
14844           required: true
14845           type: string
14846           example: __INTERFACE-NAME__
14847         - name: l3-interface-ipv4-address
14848           in: path
14849           description: IP address
14850           required: true
14851           type: string
14852           example: __L3-INTERFACE-IPV4-ADDRESS__
14853         - name: body
14854           in: body
14855           description: l3-interface-ipv4-address-list object that needs to be created or updated.
14856           required: true
14857           schema:
14858             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
14859     delete:
14860       tags:
14861         - CloudInfrastructure
14862       summary: delete an existing l3-interface-ipv4-address-list
14863       description: delete an existing l3-interface-ipv4-address-list
14864       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14865       consumes:
14866         - application/json
14867         - application/xml
14868       produces:
14869         - application/json
14870         - application/xml
14871       responses:
14872         "default":
14873           description: Response codes found in [response codes](https://wiki.onap.org/).
14874       parameters:
14875         - name: hostname
14876           in: path
14877           description: Value from executing hostname on the compute node.
14878           required: true
14879           type: string
14880           example: __HOSTNAME__
14881         - name: interface-name
14882           in: path
14883           description: Name that identifies the link aggregate interface
14884           required: true
14885           type: string
14886           example: __INTERFACE-NAME__
14887         - name: interface-name
14888           in: path
14889           description: Name given to the interface
14890           required: true
14891           type: string
14892           example: __INTERFACE-NAME__
14893         - name: l3-interface-ipv4-address
14894           in: path
14895           description: IP address
14896           required: true
14897           type: string
14898           example: __L3-INTERFACE-IPV4-ADDRESS__
14899         - name: resource-version
14900           in: query
14901           description: resource-version for concurrency
14902           required: true
14903           type: string
14904   /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:
14905     put:
14906       tags:
14907         - CloudInfrastructure
14908       summary: see node definition for valid relationships
14909       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14910       consumes:
14911         - application/json
14912         - application/xml
14913       produces:
14914         - application/json
14915         - application/xml
14916       responses:
14917         "default":
14918           description: Response codes found in [response codes](https://wiki.onap.org/).
14919       parameters:
14920         - name: hostname
14921           in: path
14922           description: Value from executing hostname on the compute node.
14923           required: true
14924           type: string
14925           example: __HOSTNAME__
14926         - name: interface-name
14927           in: path
14928           description: Name that identifies the link aggregate interface
14929           required: true
14930           type: string
14931           example: __INTERFACE-NAME__
14932         - name: interface-name
14933           in: path
14934           description: Name given to the interface
14935           required: true
14936           type: string
14937           example: __INTERFACE-NAME__
14938         - name: l3-interface-ipv6-address
14939           in: path
14940           description: IP address
14941           required: true
14942           type: string
14943           example: __L3-INTERFACE-IPV6-ADDRESS__
14944         - name: body
14945           in: body
14946           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14947           required: true
14948           schema:
14949             $ref: "#/definitions/relationship"
14950     delete:
14951       tags:
14952         - CloudInfrastructure
14953       summary: delete an existing relationship
14954       description: delete an existing relationship
14955       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14956       consumes:
14957         - application/json
14958         - application/xml
14959       produces:
14960         - application/json
14961         - application/xml
14962       responses:
14963         "default":
14964           description: Response codes found in [response codes](https://wiki.onap.org/).
14965       parameters:
14966         - name: hostname
14967           in: path
14968           description: Value from executing hostname on the compute node.
14969           required: true
14970           type: string
14971           example: __HOSTNAME__
14972         - name: interface-name
14973           in: path
14974           description: Name that identifies the link aggregate interface
14975           required: true
14976           type: string
14977           example: __INTERFACE-NAME__
14978         - name: interface-name
14979           in: path
14980           description: Name given to the interface
14981           required: true
14982           type: string
14983           example: __INTERFACE-NAME__
14984         - name: l3-interface-ipv6-address
14985           in: path
14986           description: IP address
14987           required: true
14988           type: string
14989           example: __L3-INTERFACE-IPV6-ADDRESS__
14990   /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}:
14991     get:
14992       tags:
14993         - CloudInfrastructure
14994       summary: returns l3-interface-ipv6-address-list
14995       description: returns l3-interface-ipv6-address-list
14996       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14997       produces:
14998         - application/json
14999         - application/xml
15000       responses:
15001         "200":
15002           description: successful operation
15003           schema:
15004               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
15005         "default":
15006           description: Response codes found in [response codes](https://wiki.onap.org/).
15007       parameters:
15008         - name: hostname
15009           in: path
15010           description: Value from executing hostname on the compute node.
15011           required: true
15012           type: string
15013           example: __HOSTNAME__
15014         - name: interface-name
15015           in: path
15016           description: Name that identifies the link aggregate interface
15017           required: true
15018           type: string
15019           example: __INTERFACE-NAME__
15020         - name: interface-name
15021           in: path
15022           description: Name given to the interface
15023           required: true
15024           type: string
15025           example: __INTERFACE-NAME__
15026         - name: l3-interface-ipv6-address
15027           in: path
15028           description: IP address
15029           required: true
15030           type: string
15031           example: __L3-INTERFACE-IPV6-ADDRESS__
15032         - name: inv-status
15033           in: query
15034           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15035           required: false
15036           type: string
15037         - name: pserver-id
15038           in: query
15039           description: ID of Pserver
15040           required: false
15041           type: string
15042         - name: in-maint
15043           in: query
15044           required: false
15045           type: boolean
15046         - name: pserver-name2
15047           in: query
15048           description: alternative pserver name
15049           required: false
15050           type: string
15051         - name: interface-id
15052           in: query
15053           description: ID of interface
15054           required: false
15055           type: string
15056         - name: interface-role
15057           in: query
15058           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15059           required: false
15060           type: string
15061         - name: interface-id
15062           in: query
15063           description: ID of interface
15064           required: false
15065           type: string
15066         - name: macaddr
15067           in: query
15068           description: MAC address for the interface
15069           required: false
15070           type: string
15071         - name: network-name
15072           in: query
15073           description: Name of the network
15074           required: false
15075           type: string
15076         - name: vlan-id-inner
15077           in: query
15078           description: Inner VLAN tag
15079           required: false
15080           type: integer
15081           format: int64
15082         - name: neutron-network-id
15083           in: query
15084           description: Neutron network id of the interface that address belongs to
15085           required: false
15086           type: string
15087         - name: neutron-subnet-id
15088           in: query
15089           description: Neutron id of subnet that address belongs to
15090           required: false
15091           type: string
15092     put:
15093       tags:
15094         - CloudInfrastructure
15095       summary: create or update an existing l3-interface-ipv6-address-list
15096       description: |
15097         Create or update an existing l3-interface-ipv6-address-list.
15098         #
15099         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
15100       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15101       consumes:
15102         - application/json
15103         - application/xml
15104       produces:
15105         - application/json
15106         - application/xml
15107       responses:
15108         "default":
15109           description: Response codes found in [response codes](https://wiki.onap.org/).
15110       parameters:
15111         - name: hostname
15112           in: path
15113           description: Value from executing hostname on the compute node.
15114           required: true
15115           type: string
15116           example: __HOSTNAME__
15117         - name: interface-name
15118           in: path
15119           description: Name that identifies the link aggregate interface
15120           required: true
15121           type: string
15122           example: __INTERFACE-NAME__
15123         - name: interface-name
15124           in: path
15125           description: Name given to the interface
15126           required: true
15127           type: string
15128           example: __INTERFACE-NAME__
15129         - name: l3-interface-ipv6-address
15130           in: path
15131           description: IP address
15132           required: true
15133           type: string
15134           example: __L3-INTERFACE-IPV6-ADDRESS__
15135         - name: body
15136           in: body
15137           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
15138           required: true
15139           schema:
15140             $ref: "#/definitions/l3-interface-ipv6-address-list"
15141     patch:
15142       tags:
15143         - CloudInfrastructure
15144       summary: update an existing l3-interface-ipv6-address-list
15145       description: |
15146         Update an existing l3-interface-ipv6-address-list
15147         #
15148         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15149         The PUT operation will entirely replace an existing object.
15150         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.
15151         #
15152         Other differences between PUT and PATCH are:
15153         #
15154         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15155         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15156         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15157       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15158       consumes:
15159         - application/json
15160         - application/xml
15161       produces:
15162         - application/json
15163         - application/xml
15164       responses:
15165         "default":
15166           description: Response codes found in [response codes](https://wiki.onap.org/).
15167       parameters:
15168         - name: hostname
15169           in: path
15170           description: Value from executing hostname on the compute node.
15171           required: true
15172           type: string
15173           example: __HOSTNAME__
15174         - name: interface-name
15175           in: path
15176           description: Name that identifies the link aggregate interface
15177           required: true
15178           type: string
15179           example: __INTERFACE-NAME__
15180         - name: interface-name
15181           in: path
15182           description: Name given to the interface
15183           required: true
15184           type: string
15185           example: __INTERFACE-NAME__
15186         - name: l3-interface-ipv6-address
15187           in: path
15188           description: IP address
15189           required: true
15190           type: string
15191           example: __L3-INTERFACE-IPV6-ADDRESS__
15192         - name: body
15193           in: body
15194           description: l3-interface-ipv6-address-list object that needs to be created or updated.
15195           required: true
15196           schema:
15197             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
15198     delete:
15199       tags:
15200         - CloudInfrastructure
15201       summary: delete an existing l3-interface-ipv6-address-list
15202       description: delete an existing l3-interface-ipv6-address-list
15203       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
15204       consumes:
15205         - application/json
15206         - application/xml
15207       produces:
15208         - application/json
15209         - application/xml
15210       responses:
15211         "default":
15212           description: Response codes found in [response codes](https://wiki.onap.org/).
15213       parameters:
15214         - name: hostname
15215           in: path
15216           description: Value from executing hostname on the compute node.
15217           required: true
15218           type: string
15219           example: __HOSTNAME__
15220         - name: interface-name
15221           in: path
15222           description: Name that identifies the link aggregate interface
15223           required: true
15224           type: string
15225           example: __INTERFACE-NAME__
15226         - name: interface-name
15227           in: path
15228           description: Name given to the interface
15229           required: true
15230           type: string
15231           example: __INTERFACE-NAME__
15232         - name: l3-interface-ipv6-address
15233           in: path
15234           description: IP address
15235           required: true
15236           type: string
15237           example: __L3-INTERFACE-IPV6-ADDRESS__
15238         - name: resource-version
15239           in: query
15240           description: resource-version for concurrency
15241           required: true
15242           type: string
15243   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
15244     get:
15245       tags:
15246         - CloudInfrastructure
15247       summary: returns l-interface
15248       description: returns l-interface
15249       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15250       produces:
15251         - application/json
15252         - application/xml
15253       responses:
15254         "200":
15255           description: successful operation
15256           schema:
15257               $ref: "#/getDefinitions/l-interface"
15258         "default":
15259           description: Response codes found in [response codes](https://wiki.onap.org/).
15260       parameters:
15261         - name: hostname
15262           in: path
15263           description: Value from executing hostname on the compute node.
15264           required: true
15265           type: string
15266           example: __HOSTNAME__
15267         - name: interface-name
15268           in: path
15269           description: Name that identifies the link aggregate interface
15270           required: true
15271           type: string
15272           example: __INTERFACE-NAME__
15273         - name: interface-name
15274           in: path
15275           description: Name given to the interface
15276           required: true
15277           type: string
15278           example: __INTERFACE-NAME__
15279         - name: inv-status
15280           in: query
15281           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15282           required: false
15283           type: string
15284         - name: pserver-id
15285           in: query
15286           description: ID of Pserver
15287           required: false
15288           type: string
15289         - name: in-maint
15290           in: query
15291           required: false
15292           type: boolean
15293         - name: pserver-name2
15294           in: query
15295           description: alternative pserver name
15296           required: false
15297           type: string
15298         - name: interface-id
15299           in: query
15300           description: ID of interface
15301           required: false
15302           type: string
15303         - name: interface-role
15304           in: query
15305           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15306           required: false
15307           type: string
15308         - name: interface-id
15309           in: query
15310           description: ID of interface
15311           required: false
15312           type: string
15313         - name: macaddr
15314           in: query
15315           description: MAC address for the interface
15316           required: false
15317           type: string
15318         - name: network-name
15319           in: query
15320           description: Name of the network
15321           required: false
15322           type: string
15323     put:
15324       tags:
15325         - CloudInfrastructure
15326       summary: create or update an existing l-interface
15327       description: |
15328         Create or update an existing l-interface.
15329         #
15330         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
15331       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15332       consumes:
15333         - application/json
15334         - application/xml
15335       produces:
15336         - application/json
15337         - application/xml
15338       responses:
15339         "default":
15340           description: Response codes found in [response codes](https://wiki.onap.org/).
15341       parameters:
15342         - name: hostname
15343           in: path
15344           description: Value from executing hostname on the compute node.
15345           required: true
15346           type: string
15347           example: __HOSTNAME__
15348         - name: interface-name
15349           in: path
15350           description: Name that identifies the link aggregate interface
15351           required: true
15352           type: string
15353           example: __INTERFACE-NAME__
15354         - name: interface-name
15355           in: path
15356           description: Name given to the interface
15357           required: true
15358           type: string
15359           example: __INTERFACE-NAME__
15360         - name: body
15361           in: body
15362           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
15363           required: true
15364           schema:
15365             $ref: "#/definitions/l-interface"
15366     patch:
15367       tags:
15368         - CloudInfrastructure
15369       summary: update an existing l-interface
15370       description: |
15371         Update an existing l-interface
15372         #
15373         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15374         The PUT operation will entirely replace an existing object.
15375         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.
15376         #
15377         Other differences between PUT and PATCH are:
15378         #
15379         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15380         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15381         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15382       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15383       consumes:
15384         - application/json
15385         - application/xml
15386       produces:
15387         - application/json
15388         - application/xml
15389       responses:
15390         "default":
15391           description: Response codes found in [response codes](https://wiki.onap.org/).
15392       parameters:
15393         - name: hostname
15394           in: path
15395           description: Value from executing hostname on the compute node.
15396           required: true
15397           type: string
15398           example: __HOSTNAME__
15399         - name: interface-name
15400           in: path
15401           description: Name that identifies the link aggregate interface
15402           required: true
15403           type: string
15404           example: __INTERFACE-NAME__
15405         - name: interface-name
15406           in: path
15407           description: Name given to the interface
15408           required: true
15409           type: string
15410           example: __INTERFACE-NAME__
15411         - name: body
15412           in: body
15413           description: l-interface object that needs to be created or updated.
15414           required: true
15415           schema:
15416             $ref: "#/patchDefinitions/l-interface"
15417     delete:
15418       tags:
15419         - CloudInfrastructure
15420       summary: delete an existing l-interface
15421       description: delete an existing l-interface
15422       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
15423       consumes:
15424         - application/json
15425         - application/xml
15426       produces:
15427         - application/json
15428         - application/xml
15429       responses:
15430         "default":
15431           description: Response codes found in [response codes](https://wiki.onap.org/).
15432       parameters:
15433         - name: hostname
15434           in: path
15435           description: Value from executing hostname on the compute node.
15436           required: true
15437           type: string
15438           example: __HOSTNAME__
15439         - name: interface-name
15440           in: path
15441           description: Name that identifies the link aggregate interface
15442           required: true
15443           type: string
15444           example: __INTERFACE-NAME__
15445         - name: interface-name
15446           in: path
15447           description: Name given to the interface
15448           required: true
15449           type: string
15450           example: __INTERFACE-NAME__
15451         - name: resource-version
15452           in: query
15453           description: resource-version for concurrency
15454           required: true
15455           type: string
15456   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
15457     get:
15458       tags:
15459         - CloudInfrastructure
15460       summary: returns l-interfaces
15461       description: returns l-interfaces
15462       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
15463       produces:
15464         - application/json
15465         - application/xml
15466       responses:
15467         "200":
15468           description: successful operation
15469           schema:
15470               $ref: "#/getDefinitions/l-interfaces"
15471         "default":
15472           description: Response codes found in [response codes](https://wiki.onap.org/).
15473       parameters:
15474         - name: hostname
15475           in: path
15476           description: Value from executing hostname on the compute node.
15477           required: true
15478           type: string
15479           example: __HOSTNAME__
15480         - name: interface-name
15481           in: path
15482           description: Name that identifies the link aggregate interface
15483           required: true
15484           type: string
15485           example: __INTERFACE-NAME__
15486         - name: inv-status
15487           in: query
15488           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15489           required: false
15490           type: string
15491         - name: pserver-id
15492           in: query
15493           description: ID of Pserver
15494           required: false
15495           type: string
15496         - name: in-maint
15497           in: query
15498           required: false
15499           type: boolean
15500         - name: pserver-name2
15501           in: query
15502           description: alternative pserver name
15503           required: false
15504           type: string
15505         - name: interface-id
15506           in: query
15507           description: ID of interface
15508           required: false
15509           type: string
15510         - name: interface-role
15511           in: query
15512           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15513           required: false
15514           type: string
15515   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
15516     get:
15517       tags:
15518         - CloudInfrastructure
15519       summary: returns lag-interface
15520       description: returns lag-interface
15521       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
15522       produces:
15523         - application/json
15524         - application/xml
15525       responses:
15526         "200":
15527           description: successful operation
15528           schema:
15529               $ref: "#/getDefinitions/lag-interface"
15530         "default":
15531           description: Response codes found in [response codes](https://wiki.onap.org/).
15532       parameters:
15533         - name: hostname
15534           in: path
15535           description: Value from executing hostname on the compute node.
15536           required: true
15537           type: string
15538           example: __HOSTNAME__
15539         - name: interface-name
15540           in: path
15541           description: Name that identifies the link aggregate interface
15542           required: true
15543           type: string
15544           example: __INTERFACE-NAME__
15545         - name: inv-status
15546           in: query
15547           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15548           required: false
15549           type: string
15550         - name: pserver-id
15551           in: query
15552           description: ID of Pserver
15553           required: false
15554           type: string
15555         - name: in-maint
15556           in: query
15557           required: false
15558           type: boolean
15559         - name: pserver-name2
15560           in: query
15561           description: alternative pserver name
15562           required: false
15563           type: string
15564         - name: interface-id
15565           in: query
15566           description: ID of interface
15567           required: false
15568           type: string
15569         - name: interface-role
15570           in: query
15571           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
15572           required: false
15573           type: string
15574     put:
15575       tags:
15576         - CloudInfrastructure
15577       summary: create or update an existing lag-interface
15578       description: |
15579         Create or update an existing lag-interface.
15580         #
15581         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
15582       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
15583       consumes:
15584         - application/json
15585         - application/xml
15586       produces:
15587         - application/json
15588         - application/xml
15589       responses:
15590         "default":
15591           description: Response codes found in [response codes](https://wiki.onap.org/).
15592       parameters:
15593         - name: hostname
15594           in: path
15595           description: Value from executing hostname on the compute node.
15596           required: true
15597           type: string
15598           example: __HOSTNAME__
15599         - name: interface-name
15600           in: path
15601           description: Name that identifies the link aggregate interface
15602           required: true
15603           type: string
15604           example: __INTERFACE-NAME__
15605         - name: body
15606           in: body
15607           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
15608           required: true
15609           schema:
15610             $ref: "#/definitions/lag-interface"
15611     patch:
15612       tags:
15613         - CloudInfrastructure
15614       summary: update an existing lag-interface
15615       description: |
15616         Update an existing lag-interface
15617         #
15618         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15619         The PUT operation will entirely replace an existing object.
15620         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.
15621         #
15622         Other differences between PUT and PATCH are:
15623         #
15624         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15625         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15626         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15627       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
15628       consumes:
15629         - application/json
15630         - application/xml
15631       produces:
15632         - application/json
15633         - application/xml
15634       responses:
15635         "default":
15636           description: Response codes found in [response codes](https://wiki.onap.org/).
15637       parameters:
15638         - name: hostname
15639           in: path
15640           description: Value from executing hostname on the compute node.
15641           required: true
15642           type: string
15643           example: __HOSTNAME__
15644         - name: interface-name
15645           in: path
15646           description: Name that identifies the link aggregate interface
15647           required: true
15648           type: string
15649           example: __INTERFACE-NAME__
15650         - name: body
15651           in: body
15652           description: lag-interface object that needs to be created or updated.
15653           required: true
15654           schema:
15655             $ref: "#/patchDefinitions/lag-interface"
15656     delete:
15657       tags:
15658         - CloudInfrastructure
15659       summary: delete an existing lag-interface
15660       description: delete an existing lag-interface
15661       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
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: hostname
15673           in: path
15674           description: Value from executing hostname on the compute node.
15675           required: true
15676           type: string
15677           example: __HOSTNAME__
15678         - name: interface-name
15679           in: path
15680           description: Name that identifies the link aggregate interface
15681           required: true
15682           type: string
15683           example: __INTERFACE-NAME__
15684         - name: resource-version
15685           in: query
15686           description: resource-version for concurrency
15687           required: true
15688           type: string
15689   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
15690     get:
15691       tags:
15692         - CloudInfrastructure
15693       summary: returns lag-interfaces
15694       description: returns lag-interfaces
15695       operationId: getCloudInfrastructurePserversPserverLagInterfaces
15696       produces:
15697         - application/json
15698         - application/xml
15699       responses:
15700         "200":
15701           description: successful operation
15702           schema:
15703               $ref: "#/getDefinitions/lag-interfaces"
15704         "default":
15705           description: Response codes found in [response codes](https://wiki.onap.org/).
15706       parameters:
15707         - name: hostname
15708           in: path
15709           description: Value from executing hostname on the compute node.
15710           required: true
15711           type: string
15712           example: __HOSTNAME__
15713         - name: inv-status
15714           in: query
15715           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15716           required: false
15717           type: string
15718         - name: pserver-id
15719           in: query
15720           description: ID of Pserver
15721           required: false
15722           type: string
15723         - name: in-maint
15724           in: query
15725           required: false
15726           type: boolean
15727         - name: pserver-name2
15728           in: query
15729           description: alternative pserver name
15730           required: false
15731           type: string
15732   /cloud-infrastructure/pservers/pserver/{hostname}:
15733     get:
15734       tags:
15735         - CloudInfrastructure
15736       summary: returns pserver
15737       description: returns pserver
15738       operationId: getCloudInfrastructurePserversPserver
15739       produces:
15740         - application/json
15741         - application/xml
15742       responses:
15743         "200":
15744           description: successful operation
15745           schema:
15746               $ref: "#/getDefinitions/pserver"
15747         "default":
15748           description: Response codes found in [response codes](https://wiki.onap.org/).
15749       parameters:
15750         - name: hostname
15751           in: path
15752           description: Value from executing hostname on the compute node.
15753           required: true
15754           type: string
15755           example: __HOSTNAME__
15756         - name: inv-status
15757           in: query
15758           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15759           required: false
15760           type: string
15761         - name: pserver-id
15762           in: query
15763           description: ID of Pserver
15764           required: false
15765           type: string
15766         - name: in-maint
15767           in: query
15768           required: false
15769           type: boolean
15770         - name: pserver-name2
15771           in: query
15772           description: alternative pserver name
15773           required: false
15774           type: string
15775     put:
15776       tags:
15777         - CloudInfrastructure
15778       summary: create or update an existing pserver
15779       description: |
15780         Create or update an existing pserver.
15781         #
15782         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
15783       operationId: createOrUpdateCloudInfrastructurePserversPserver
15784       consumes:
15785         - application/json
15786         - application/xml
15787       produces:
15788         - application/json
15789         - application/xml
15790       responses:
15791         "default":
15792           description: Response codes found in [response codes](https://wiki.onap.org/).
15793       parameters:
15794         - name: hostname
15795           in: path
15796           description: Value from executing hostname on the compute node.
15797           required: true
15798           type: string
15799           example: __HOSTNAME__
15800         - name: body
15801           in: body
15802           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
15803           required: true
15804           schema:
15805             $ref: "#/definitions/pserver"
15806     patch:
15807       tags:
15808         - CloudInfrastructure
15809       summary: update an existing pserver
15810       description: |
15811         Update an existing pserver
15812         #
15813         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15814         The PUT operation will entirely replace an existing object.
15815         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.
15816         #
15817         Other differences between PUT and PATCH are:
15818         #
15819         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15820         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15821         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15822       operationId: UpdateCloudInfrastructurePserversPserver
15823       consumes:
15824         - application/json
15825         - application/xml
15826       produces:
15827         - application/json
15828         - application/xml
15829       responses:
15830         "default":
15831           description: Response codes found in [response codes](https://wiki.onap.org/).
15832       parameters:
15833         - name: hostname
15834           in: path
15835           description: Value from executing hostname on the compute node.
15836           required: true
15837           type: string
15838           example: __HOSTNAME__
15839         - name: body
15840           in: body
15841           description: pserver object that needs to be created or updated.
15842           required: true
15843           schema:
15844             $ref: "#/patchDefinitions/pserver"
15845     delete:
15846       tags:
15847         - CloudInfrastructure
15848       summary: delete an existing pserver
15849       description: delete an existing pserver
15850       operationId: deleteCloudInfrastructurePserversPserver
15851       consumes:
15852         - application/json
15853         - application/xml
15854       produces:
15855         - application/json
15856         - application/xml
15857       responses:
15858         "default":
15859           description: Response codes found in [response codes](https://wiki.onap.org/).
15860       parameters:
15861         - name: hostname
15862           in: path
15863           description: Value from executing hostname on the compute node.
15864           required: true
15865           type: string
15866           example: __HOSTNAME__
15867         - name: resource-version
15868           in: query
15869           description: resource-version for concurrency
15870           required: true
15871           type: string
15872   /cloud-infrastructure/pservers:
15873     get:
15874       tags:
15875         - CloudInfrastructure
15876       summary: returns pservers
15877       description: returns pservers
15878       operationId: getCloudInfrastructurePservers
15879       produces:
15880         - application/json
15881         - application/xml
15882       responses:
15883         "200":
15884           description: successful operation
15885           schema:
15886               $ref: "#/getDefinitions/pservers"
15887         "default":
15888           description: Response codes found in [response codes](https://wiki.onap.org/).
15889   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
15890     put:
15891       tags:
15892         - CloudInfrastructure
15893       summary: see node definition for valid relationships
15894       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
15895       consumes:
15896         - application/json
15897         - application/xml
15898       produces:
15899         - application/json
15900         - application/xml
15901       responses:
15902         "default":
15903           description: Response codes found in [response codes](https://wiki.onap.org/).
15904       parameters:
15905         - name: vdc-id
15906           in: path
15907           description: Unique ID of the vdc
15908           required: true
15909           type: string
15910           example: __VDC-ID__
15911         - name: body
15912           in: body
15913           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15914           required: true
15915           schema:
15916             $ref: "#/definitions/relationship"
15917     delete:
15918       tags:
15919         - CloudInfrastructure
15920       summary: delete an existing relationship
15921       description: delete an existing relationship
15922       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
15923       consumes:
15924         - application/json
15925         - application/xml
15926       produces:
15927         - application/json
15928         - application/xml
15929       responses:
15930         "default":
15931           description: Response codes found in [response codes](https://wiki.onap.org/).
15932       parameters:
15933         - name: vdc-id
15934           in: path
15935           description: Unique ID of the vdc
15936           required: true
15937           type: string
15938           example: __VDC-ID__
15939   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
15940     get:
15941       tags:
15942         - CloudInfrastructure
15943       summary: returns virtual-data-center
15944       description: returns virtual-data-center
15945       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
15946       produces:
15947         - application/json
15948         - application/xml
15949       responses:
15950         "200":
15951           description: successful operation
15952           schema:
15953               $ref: "#/getDefinitions/virtual-data-center"
15954         "default":
15955           description: Response codes found in [response codes](https://wiki.onap.org/).
15956       parameters:
15957         - name: vdc-id
15958           in: path
15959           description: Unique ID of the vdc
15960           required: true
15961           type: string
15962           example: __VDC-ID__
15963         - name: vdc-name
15964           in: query
15965           description: Name of the virtual data center
15966           required: false
15967           type: string
15968     put:
15969       tags:
15970         - CloudInfrastructure
15971       summary: create or update an existing virtual-data-center
15972       description: |
15973         Create or update an existing virtual-data-center.
15974         #
15975         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
15976       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15977       consumes:
15978         - application/json
15979         - application/xml
15980       produces:
15981         - application/json
15982         - application/xml
15983       responses:
15984         "default":
15985           description: Response codes found in [response codes](https://wiki.onap.org/).
15986       parameters:
15987         - name: vdc-id
15988           in: path
15989           description: Unique ID of the vdc
15990           required: true
15991           type: string
15992           example: __VDC-ID__
15993         - name: body
15994           in: body
15995           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15996           required: true
15997           schema:
15998             $ref: "#/definitions/virtual-data-center"
15999     patch:
16000       tags:
16001         - CloudInfrastructure
16002       summary: update an existing virtual-data-center
16003       description: |
16004         Update an existing virtual-data-center
16005         #
16006         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16007         The PUT operation will entirely replace an existing object.
16008         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.
16009         #
16010         Other differences between PUT and PATCH are:
16011         #
16012         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16013         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16014         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16015       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
16016       consumes:
16017         - application/json
16018         - application/xml
16019       produces:
16020         - application/json
16021         - application/xml
16022       responses:
16023         "default":
16024           description: Response codes found in [response codes](https://wiki.onap.org/).
16025       parameters:
16026         - name: vdc-id
16027           in: path
16028           description: Unique ID of the vdc
16029           required: true
16030           type: string
16031           example: __VDC-ID__
16032         - name: body
16033           in: body
16034           description: virtual-data-center object that needs to be created or updated.
16035           required: true
16036           schema:
16037             $ref: "#/patchDefinitions/virtual-data-center"
16038     delete:
16039       tags:
16040         - CloudInfrastructure
16041       summary: delete an existing virtual-data-center
16042       description: delete an existing virtual-data-center
16043       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
16044       consumes:
16045         - application/json
16046         - application/xml
16047       produces:
16048         - application/json
16049         - application/xml
16050       responses:
16051         "default":
16052           description: Response codes found in [response codes](https://wiki.onap.org/).
16053       parameters:
16054         - name: vdc-id
16055           in: path
16056           description: Unique ID of the vdc
16057           required: true
16058           type: string
16059           example: __VDC-ID__
16060         - name: resource-version
16061           in: query
16062           description: resource-version for concurrency
16063           required: true
16064           type: string
16065   /cloud-infrastructure/virtual-data-centers:
16066     get:
16067       tags:
16068         - CloudInfrastructure
16069       summary: returns virtual-data-centers
16070       description: returns virtual-data-centers
16071       operationId: getCloudInfrastructureVirtualDataCenters
16072       produces:
16073         - application/json
16074         - application/xml
16075       responses:
16076         "200":
16077           description: successful operation
16078           schema:
16079               $ref: "#/getDefinitions/virtual-data-centers"
16080         "default":
16081           description: Response codes found in [response codes](https://wiki.onap.org/).
16082   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
16083     put:
16084       tags:
16085         - CloudInfrastructure
16086       summary: see node definition for valid relationships
16087       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
16088       consumes:
16089         - application/json
16090         - application/xml
16091       produces:
16092         - application/json
16093         - application/xml
16094       responses:
16095         "default":
16096           description: Response codes found in [response codes](https://wiki.onap.org/).
16097       parameters:
16098         - name: operational-environment-id
16099           in: path
16100           description: UUID of an operational environment
16101           required: true
16102           type: string
16103           example: __OPERATIONAL-ENVIRONMENT-ID__
16104         - name: body
16105           in: body
16106           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
16107           required: true
16108           schema:
16109             $ref: "#/definitions/relationship"
16110     delete:
16111       tags:
16112         - CloudInfrastructure
16113       summary: delete an existing relationship
16114       description: delete an existing relationship
16115       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
16116       consumes:
16117         - application/json
16118         - application/xml
16119       produces:
16120         - application/json
16121         - application/xml
16122       responses:
16123         "default":
16124           description: Response codes found in [response codes](https://wiki.onap.org/).
16125       parameters:
16126         - name: operational-environment-id
16127           in: path
16128           description: UUID of an operational environment
16129           required: true
16130           type: string
16131           example: __OPERATIONAL-ENVIRONMENT-ID__
16132   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
16133     get:
16134       tags:
16135         - CloudInfrastructure
16136       summary: returns operational-environment
16137       description: returns operational-environment
16138       operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16139       produces:
16140         - application/json
16141         - application/xml
16142       responses:
16143         "200":
16144           description: successful operation
16145           schema:
16146               $ref: "#/getDefinitions/operational-environment"
16147         "default":
16148           description: Response codes found in [response codes](https://wiki.onap.org/).
16149       parameters:
16150         - name: operational-environment-id
16151           in: path
16152           description: UUID of an operational environment
16153           required: true
16154           type: string
16155           example: __OPERATIONAL-ENVIRONMENT-ID__
16156     put:
16157       tags:
16158         - CloudInfrastructure
16159       summary: create or update an existing operational-environment
16160       description: |
16161         Create or update an existing operational-environment.
16162         #
16163         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
16164       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16165       consumes:
16166         - application/json
16167         - application/xml
16168       produces:
16169         - application/json
16170         - application/xml
16171       responses:
16172         "default":
16173           description: Response codes found in [response codes](https://wiki.onap.org/).
16174       parameters:
16175         - name: operational-environment-id
16176           in: path
16177           description: UUID of an operational environment
16178           required: true
16179           type: string
16180           example: __OPERATIONAL-ENVIRONMENT-ID__
16181         - name: body
16182           in: body
16183           description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
16184           required: true
16185           schema:
16186             $ref: "#/definitions/operational-environment"
16187     patch:
16188       tags:
16189         - CloudInfrastructure
16190       summary: update an existing operational-environment
16191       description: |
16192         Update an existing operational-environment
16193         #
16194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16195         The PUT operation will entirely replace an existing object.
16196         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.
16197         #
16198         Other differences between PUT and PATCH are:
16199         #
16200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16203       operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16204       consumes:
16205         - application/json
16206         - application/xml
16207       produces:
16208         - application/json
16209         - application/xml
16210       responses:
16211         "default":
16212           description: Response codes found in [response codes](https://wiki.onap.org/).
16213       parameters:
16214         - name: operational-environment-id
16215           in: path
16216           description: UUID of an operational environment
16217           required: true
16218           type: string
16219           example: __OPERATIONAL-ENVIRONMENT-ID__
16220         - name: body
16221           in: body
16222           description: operational-environment object that needs to be created or updated.
16223           required: true
16224           schema:
16225             $ref: "#/patchDefinitions/operational-environment"
16226     delete:
16227       tags:
16228         - CloudInfrastructure
16229       summary: delete an existing operational-environment
16230       description: delete an existing operational-environment
16231       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
16232       consumes:
16233         - application/json
16234         - application/xml
16235       produces:
16236         - application/json
16237         - application/xml
16238       responses:
16239         "default":
16240           description: Response codes found in [response codes](https://wiki.onap.org/).
16241       parameters:
16242         - name: operational-environment-id
16243           in: path
16244           description: UUID of an operational environment
16245           required: true
16246           type: string
16247           example: __OPERATIONAL-ENVIRONMENT-ID__
16248         - name: resource-version
16249           in: query
16250           description: resource-version for concurrency
16251           required: true
16252           type: string
16253   /cloud-infrastructure/operational-environments:
16254     get:
16255       tags:
16256         - CloudInfrastructure
16257       summary: returns operational-environments
16258       description: returns operational-environments
16259       operationId: getCloudInfrastructureOperationalEnvironments
16260       produces:
16261         - application/json
16262         - application/xml
16263       responses:
16264         "200":
16265           description: successful operation
16266           schema:
16267               $ref: "#/getDefinitions/operational-environments"
16268         "default":
16269           description: Response codes found in [response codes](https://wiki.onap.org/).
16270   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
16271     put:
16272       tags:
16273         - Business
16274       summary: see node definition for valid relationships
16275       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
16276       consumes:
16277         - application/json
16278         - application/xml
16279       produces:
16280         - application/json
16281         - application/xml
16282       responses:
16283         "default":
16284           description: Response codes found in [response codes](https://wiki.onap.org/).
16285       parameters:
16286         - name: resource-instance-id
16287           in: path
16288           description: Unique id of resource instance.
16289           required: true
16290           type: string
16291           example: __RESOURCE-INSTANCE-ID__
16292         - name: body
16293           in: body
16294           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
16295           required: true
16296           schema:
16297             $ref: "#/definitions/relationship"
16298     delete:
16299       tags:
16300         - Business
16301       summary: delete an existing relationship
16302       description: delete an existing relationship
16303       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
16304       consumes:
16305         - application/json
16306         - application/xml
16307       produces:
16308         - application/json
16309         - application/xml
16310       responses:
16311         "default":
16312           description: Response codes found in [response codes](https://wiki.onap.org/).
16313       parameters:
16314         - name: resource-instance-id
16315           in: path
16316           description: Unique id of resource instance.
16317           required: true
16318           type: string
16319           example: __RESOURCE-INSTANCE-ID__
16320   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
16321     get:
16322       tags:
16323         - Business
16324       summary: returns metadatum
16325       description: returns metadatum
16326       operationId: getBusinessConnectorsConnectorMetadataMetadatum
16327       produces:
16328         - application/json
16329         - application/xml
16330       responses:
16331         "200":
16332           description: successful operation
16333           schema:
16334               $ref: "#/getDefinitions/metadatum"
16335         "default":
16336           description: Response codes found in [response codes](https://wiki.onap.org/).
16337       parameters:
16338         - name: resource-instance-id
16339           in: path
16340           description: Unique id of resource instance.
16341           required: true
16342           type: string
16343           example: __RESOURCE-INSTANCE-ID__
16344         - name: metaname
16345           in: path
16346           required: true
16347           type: string
16348           example: __METANAME__
16349         - name: model-invariant-id
16350           in: query
16351           description: the ASDC model id for this resource or service model.
16352           required: false
16353           type: string
16354         - name: model-version-id
16355           in: query
16356           description: the ASDC model version for this resource or service model.
16357           required: false
16358           type: string
16359         - name: widget-model-id
16360           in: query
16361           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16362           required: false
16363           type: string
16364         - name: widget-model-version
16365           in: query
16366           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16367           required: false
16368           type: string
16369     put:
16370       tags:
16371         - Business
16372       summary: create or update an existing metadatum
16373       description: |
16374         Create or update an existing metadatum.
16375         #
16376         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
16377       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
16378       consumes:
16379         - application/json
16380         - application/xml
16381       produces:
16382         - application/json
16383         - application/xml
16384       responses:
16385         "default":
16386           description: Response codes found in [response codes](https://wiki.onap.org/).
16387       parameters:
16388         - name: resource-instance-id
16389           in: path
16390           description: Unique id of resource instance.
16391           required: true
16392           type: string
16393           example: __RESOURCE-INSTANCE-ID__
16394         - name: metaname
16395           in: path
16396           required: true
16397           type: string
16398           example: __METANAME__
16399         - name: body
16400           in: body
16401           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)
16402           required: true
16403           schema:
16404             $ref: "#/definitions/metadatum"
16405     patch:
16406       tags:
16407         - Business
16408       summary: update an existing metadatum
16409       description: |
16410         Update an existing metadatum
16411         #
16412         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16413         The PUT operation will entirely replace an existing object.
16414         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.
16415         #
16416         Other differences between PUT and PATCH are:
16417         #
16418         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16419         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16420         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16421       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
16422       consumes:
16423         - application/json
16424         - application/xml
16425       produces:
16426         - application/json
16427         - application/xml
16428       responses:
16429         "default":
16430           description: Response codes found in [response codes](https://wiki.onap.org/).
16431       parameters:
16432         - name: resource-instance-id
16433           in: path
16434           description: Unique id of resource instance.
16435           required: true
16436           type: string
16437           example: __RESOURCE-INSTANCE-ID__
16438         - name: metaname
16439           in: path
16440           required: true
16441           type: string
16442           example: __METANAME__
16443         - name: body
16444           in: body
16445           description: metadatum object that needs to be created or updated.
16446           required: true
16447           schema:
16448             $ref: "#/patchDefinitions/metadatum"
16449     delete:
16450       tags:
16451         - Business
16452       summary: delete an existing metadatum
16453       description: delete an existing metadatum
16454       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
16455       consumes:
16456         - application/json
16457         - application/xml
16458       produces:
16459         - application/json
16460         - application/xml
16461       responses:
16462         "default":
16463           description: Response codes found in [response codes](https://wiki.onap.org/).
16464       parameters:
16465         - name: resource-instance-id
16466           in: path
16467           description: Unique id of resource instance.
16468           required: true
16469           type: string
16470           example: __RESOURCE-INSTANCE-ID__
16471         - name: metaname
16472           in: path
16473           required: true
16474           type: string
16475           example: __METANAME__
16476         - name: resource-version
16477           in: query
16478           description: resource-version for concurrency
16479           required: true
16480           type: string
16481   /business/connectors/connector/{resource-instance-id}/metadata:
16482     get:
16483       tags:
16484         - Business
16485       summary: returns metadata
16486       description: returns metadata
16487       operationId: getBusinessConnectorsConnectorMetadata
16488       produces:
16489         - application/json
16490         - application/xml
16491       responses:
16492         "200":
16493           description: successful operation
16494           schema:
16495               $ref: "#/getDefinitions/metadata"
16496         "default":
16497           description: Response codes found in [response codes](https://wiki.onap.org/).
16498       parameters:
16499         - name: resource-instance-id
16500           in: path
16501           description: Unique id of resource instance.
16502           required: true
16503           type: string
16504           example: __RESOURCE-INSTANCE-ID__
16505         - name: model-invariant-id
16506           in: query
16507           description: the ASDC model id for this resource or service model.
16508           required: false
16509           type: string
16510         - name: model-version-id
16511           in: query
16512           description: the ASDC model version for this resource or service model.
16513           required: false
16514           type: string
16515         - name: widget-model-id
16516           in: query
16517           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16518           required: false
16519           type: string
16520         - name: widget-model-version
16521           in: query
16522           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16523           required: false
16524           type: string
16525   /business/connectors/connector/{resource-instance-id}:
16526     get:
16527       tags:
16528         - Business
16529       summary: returns connector
16530       description: returns connector
16531       operationId: getBusinessConnectorsConnector
16532       produces:
16533         - application/json
16534         - application/xml
16535       responses:
16536         "200":
16537           description: successful operation
16538           schema:
16539               $ref: "#/getDefinitions/connector"
16540         "default":
16541           description: Response codes found in [response codes](https://wiki.onap.org/).
16542       parameters:
16543         - name: resource-instance-id
16544           in: path
16545           description: Unique id of resource instance.
16546           required: true
16547           type: string
16548           example: __RESOURCE-INSTANCE-ID__
16549         - name: model-invariant-id
16550           in: query
16551           description: the ASDC model id for this resource or service model.
16552           required: false
16553           type: string
16554         - name: model-version-id
16555           in: query
16556           description: the ASDC model version for this resource or service model.
16557           required: false
16558           type: string
16559         - name: widget-model-id
16560           in: query
16561           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16562           required: false
16563           type: string
16564         - name: widget-model-version
16565           in: query
16566           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16567           required: false
16568           type: string
16569     put:
16570       tags:
16571         - Business
16572       summary: create or update an existing connector
16573       description: |
16574         Create or update an existing connector.
16575         #
16576         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
16577       operationId: createOrUpdateBusinessConnectorsConnector
16578       consumes:
16579         - application/json
16580         - application/xml
16581       produces:
16582         - application/json
16583         - application/xml
16584       responses:
16585         "default":
16586           description: Response codes found in [response codes](https://wiki.onap.org/).
16587       parameters:
16588         - name: resource-instance-id
16589           in: path
16590           description: Unique id of resource instance.
16591           required: true
16592           type: string
16593           example: __RESOURCE-INSTANCE-ID__
16594         - name: body
16595           in: body
16596           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
16597           required: true
16598           schema:
16599             $ref: "#/definitions/connector"
16600     patch:
16601       tags:
16602         - Business
16603       summary: update an existing connector
16604       description: |
16605         Update an existing connector
16606         #
16607         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16608         The PUT operation will entirely replace an existing object.
16609         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.
16610         #
16611         Other differences between PUT and PATCH are:
16612         #
16613         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16614         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16615         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16616       operationId: UpdateBusinessConnectorsConnector
16617       consumes:
16618         - application/json
16619         - application/xml
16620       produces:
16621         - application/json
16622         - application/xml
16623       responses:
16624         "default":
16625           description: Response codes found in [response codes](https://wiki.onap.org/).
16626       parameters:
16627         - name: resource-instance-id
16628           in: path
16629           description: Unique id of resource instance.
16630           required: true
16631           type: string
16632           example: __RESOURCE-INSTANCE-ID__
16633         - name: body
16634           in: body
16635           description: connector object that needs to be created or updated.
16636           required: true
16637           schema:
16638             $ref: "#/patchDefinitions/connector"
16639     delete:
16640       tags:
16641         - Business
16642       summary: delete an existing connector
16643       description: delete an existing connector
16644       operationId: deleteBusinessConnectorsConnector
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: resource-instance-id
16656           in: path
16657           description: Unique id of resource instance.
16658           required: true
16659           type: string
16660           example: __RESOURCE-INSTANCE-ID__
16661         - name: resource-version
16662           in: query
16663           description: resource-version for concurrency
16664           required: true
16665           type: string
16666   /business/connectors:
16667     get:
16668       tags:
16669         - Business
16670       summary: returns connectors
16671       description: returns connectors
16672       operationId: getBusinessConnectors
16673       produces:
16674         - application/json
16675         - application/xml
16676       responses:
16677         "200":
16678           description: successful operation
16679           schema:
16680               $ref: "#/getDefinitions/connectors"
16681         "default":
16682           description: Response codes found in [response codes](https://wiki.onap.org/).
16683   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
16684     put:
16685       tags:
16686         - Business
16687       summary: see node definition for valid relationships
16688       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
16689       consumes:
16690         - application/json
16691         - application/xml
16692       produces:
16693         - application/json
16694         - application/xml
16695       responses:
16696         "default":
16697           description: Response codes found in [response codes](https://wiki.onap.org/).
16698       parameters:
16699         - name: global-customer-id
16700           in: path
16701           description: Global customer id used across ECOMP to uniquely identify customer.
16702           required: true
16703           type: string
16704           example: __GLOBAL-CUSTOMER-ID__
16705         - name: service-type
16706           in: path
16707           description: Value defined by orchestration to identify this service across ECOMP.
16708           required: true
16709           type: string
16710           example: __SERVICE-TYPE__
16711         - name: service-instance-id
16712           in: path
16713           description: Uniquely identifies this instance of a service
16714           required: true
16715           type: string
16716           example: __SERVICE-INSTANCE-ID__
16717         - name: body
16718           in: body
16719           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16720           required: true
16721           schema:
16722             $ref: "#/definitions/relationship"
16723     delete:
16724       tags:
16725         - Business
16726       summary: delete an existing relationship
16727       description: delete an existing relationship
16728       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
16729       consumes:
16730         - application/json
16731         - application/xml
16732       produces:
16733         - application/json
16734         - application/xml
16735       responses:
16736         "default":
16737           description: Response codes found in [response codes](https://wiki.onap.org/).
16738       parameters:
16739         - name: global-customer-id
16740           in: path
16741           description: Global customer id used across ECOMP to uniquely identify customer.
16742           required: true
16743           type: string
16744           example: __GLOBAL-CUSTOMER-ID__
16745         - name: service-type
16746           in: path
16747           description: Value defined by orchestration to identify this service across ECOMP.
16748           required: true
16749           type: string
16750           example: __SERVICE-TYPE__
16751         - name: service-instance-id
16752           in: path
16753           description: Uniquely identifies this instance of a service
16754           required: true
16755           type: string
16756           example: __SERVICE-INSTANCE-ID__
16757   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
16758     get:
16759       tags:
16760         - Business
16761       summary: returns metadatum
16762       description: returns metadatum
16763       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16764       produces:
16765         - application/json
16766         - application/xml
16767       responses:
16768         "200":
16769           description: successful operation
16770           schema:
16771               $ref: "#/getDefinitions/metadatum"
16772         "default":
16773           description: Response codes found in [response codes](https://wiki.onap.org/).
16774       parameters:
16775         - name: global-customer-id
16776           in: path
16777           description: Global customer id used across ECOMP to uniquely identify customer.
16778           required: true
16779           type: string
16780           example: __GLOBAL-CUSTOMER-ID__
16781         - name: service-type
16782           in: path
16783           description: Value defined by orchestration to identify this service across ECOMP.
16784           required: true
16785           type: string
16786           example: __SERVICE-TYPE__
16787         - name: service-instance-id
16788           in: path
16789           description: Uniquely identifies this instance of a service
16790           required: true
16791           type: string
16792           example: __SERVICE-INSTANCE-ID__
16793         - name: metaname
16794           in: path
16795           required: true
16796           type: string
16797           example: __METANAME__
16798         - name: subscriber-name
16799           in: query
16800           description: Subscriber name, an alternate way to retrieve a customer.
16801           required: false
16802           type: string
16803         - name: subscriber-type
16804           in: query
16805           description: Subscriber type, a way to provide VID with only the INFRA customers.
16806           required: false
16807           type: string
16808         - name: service-instance-name
16809           in: query
16810           description: This field will store a name assigned to the service-instance.
16811           required: false
16812           type: string
16813         - name: environment-context
16814           in: query
16815           description: This field will store the environment context assigned to the service-instance.
16816           required: false
16817           type: string
16818         - name: workload-context
16819           in: query
16820           description: This field will store the workload context assigned to the service-instance.
16821           required: false
16822           type: string
16823         - name: model-invariant-id
16824           in: query
16825           description: the ASDC model id for this resource or service model.
16826           required: false
16827           type: string
16828         - name: model-version-id
16829           in: query
16830           description: the ASDC model version for this resource or service model.
16831           required: false
16832           type: string
16833         - name: widget-model-id
16834           in: query
16835           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16836           required: false
16837           type: string
16838         - name: widget-model-version
16839           in: query
16840           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16841           required: false
16842           type: string
16843         - name: service-instance-location-id
16844           in: query
16845           description: An identifier that customers assign to the location where this service is being used.
16846           required: false
16847           type: string
16848         - name: orchestration-status
16849           in: query
16850           description: Orchestration status of this service.
16851           required: false
16852           type: string
16853     put:
16854       tags:
16855         - Business
16856       summary: create or update an existing metadatum
16857       description: |
16858         Create or update an existing metadatum.
16859         #
16860         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
16861       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16862       consumes:
16863         - application/json
16864         - application/xml
16865       produces:
16866         - application/json
16867         - application/xml
16868       responses:
16869         "default":
16870           description: Response codes found in [response codes](https://wiki.onap.org/).
16871       parameters:
16872         - name: global-customer-id
16873           in: path
16874           description: Global customer id used across ECOMP to uniquely identify customer.
16875           required: true
16876           type: string
16877           example: __GLOBAL-CUSTOMER-ID__
16878         - name: service-type
16879           in: path
16880           description: Value defined by orchestration to identify this service across ECOMP.
16881           required: true
16882           type: string
16883           example: __SERVICE-TYPE__
16884         - name: service-instance-id
16885           in: path
16886           description: Uniquely identifies this instance of a service
16887           required: true
16888           type: string
16889           example: __SERVICE-INSTANCE-ID__
16890         - name: metaname
16891           in: path
16892           required: true
16893           type: string
16894           example: __METANAME__
16895         - name: body
16896           in: body
16897           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
16898           required: true
16899           schema:
16900             $ref: "#/definitions/metadatum"
16901     patch:
16902       tags:
16903         - Business
16904       summary: update an existing metadatum
16905       description: |
16906         Update an existing metadatum
16907         #
16908         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16909         The PUT operation will entirely replace an existing object.
16910         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.
16911         #
16912         Other differences between PUT and PATCH are:
16913         #
16914         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16915         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16916         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16917       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16918       consumes:
16919         - application/json
16920         - application/xml
16921       produces:
16922         - application/json
16923         - application/xml
16924       responses:
16925         "default":
16926           description: Response codes found in [response codes](https://wiki.onap.org/).
16927       parameters:
16928         - name: global-customer-id
16929           in: path
16930           description: Global customer id used across ECOMP to uniquely identify customer.
16931           required: true
16932           type: string
16933           example: __GLOBAL-CUSTOMER-ID__
16934         - name: service-type
16935           in: path
16936           description: Value defined by orchestration to identify this service across ECOMP.
16937           required: true
16938           type: string
16939           example: __SERVICE-TYPE__
16940         - name: service-instance-id
16941           in: path
16942           description: Uniquely identifies this instance of a service
16943           required: true
16944           type: string
16945           example: __SERVICE-INSTANCE-ID__
16946         - name: metaname
16947           in: path
16948           required: true
16949           type: string
16950           example: __METANAME__
16951         - name: body
16952           in: body
16953           description: metadatum object that needs to be created or updated.
16954           required: true
16955           schema:
16956             $ref: "#/patchDefinitions/metadatum"
16957     delete:
16958       tags:
16959         - Business
16960       summary: delete an existing metadatum
16961       description: delete an existing metadatum
16962       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16963       consumes:
16964         - application/json
16965         - application/xml
16966       produces:
16967         - application/json
16968         - application/xml
16969       responses:
16970         "default":
16971           description: Response codes found in [response codes](https://wiki.onap.org/).
16972       parameters:
16973         - name: global-customer-id
16974           in: path
16975           description: Global customer id used across ECOMP to uniquely identify customer.
16976           required: true
16977           type: string
16978           example: __GLOBAL-CUSTOMER-ID__
16979         - name: service-type
16980           in: path
16981           description: Value defined by orchestration to identify this service across ECOMP.
16982           required: true
16983           type: string
16984           example: __SERVICE-TYPE__
16985         - name: service-instance-id
16986           in: path
16987           description: Uniquely identifies this instance of a service
16988           required: true
16989           type: string
16990           example: __SERVICE-INSTANCE-ID__
16991         - name: metaname
16992           in: path
16993           required: true
16994           type: string
16995           example: __METANAME__
16996         - name: resource-version
16997           in: query
16998           description: resource-version for concurrency
16999           required: true
17000           type: string
17001   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
17002     get:
17003       tags:
17004         - Business
17005       summary: returns metadata
17006       description: returns metadata
17007       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
17008       produces:
17009         - application/json
17010         - application/xml
17011       responses:
17012         "200":
17013           description: successful operation
17014           schema:
17015               $ref: "#/getDefinitions/metadata"
17016         "default":
17017           description: Response codes found in [response codes](https://wiki.onap.org/).
17018       parameters:
17019         - name: global-customer-id
17020           in: path
17021           description: Global customer id used across ECOMP to uniquely identify customer.
17022           required: true
17023           type: string
17024           example: __GLOBAL-CUSTOMER-ID__
17025         - name: service-type
17026           in: path
17027           description: Value defined by orchestration to identify this service across ECOMP.
17028           required: true
17029           type: string
17030           example: __SERVICE-TYPE__
17031         - name: service-instance-id
17032           in: path
17033           description: Uniquely identifies this instance of a service
17034           required: true
17035           type: string
17036           example: __SERVICE-INSTANCE-ID__
17037         - name: subscriber-name
17038           in: query
17039           description: Subscriber name, an alternate way to retrieve a customer.
17040           required: false
17041           type: string
17042         - name: subscriber-type
17043           in: query
17044           description: Subscriber type, a way to provide VID with only the INFRA customers.
17045           required: false
17046           type: string
17047         - name: service-instance-name
17048           in: query
17049           description: This field will store a name assigned to the service-instance.
17050           required: false
17051           type: string
17052         - name: environment-context
17053           in: query
17054           description: This field will store the environment context assigned to the service-instance.
17055           required: false
17056           type: string
17057         - name: workload-context
17058           in: query
17059           description: This field will store the workload context assigned to the service-instance.
17060           required: false
17061           type: string
17062         - name: model-invariant-id
17063           in: query
17064           description: the ASDC model id for this resource or service model.
17065           required: false
17066           type: string
17067         - name: model-version-id
17068           in: query
17069           description: the ASDC model version for this resource or service model.
17070           required: false
17071           type: string
17072         - name: widget-model-id
17073           in: query
17074           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17075           required: false
17076           type: string
17077         - name: widget-model-version
17078           in: query
17079           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17080           required: false
17081           type: string
17082         - name: service-instance-location-id
17083           in: query
17084           description: An identifier that customers assign to the location where this service is being used.
17085           required: false
17086           type: string
17087         - name: orchestration-status
17088           in: query
17089           description: Orchestration status of this service.
17090           required: false
17091           type: string
17092   /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:
17093     put:
17094       tags:
17095         - Business
17096       summary: see node definition for valid relationships
17097       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
17098       consumes:
17099         - application/json
17100         - application/xml
17101       produces:
17102         - application/json
17103         - application/xml
17104       responses:
17105         "default":
17106           description: Response codes found in [response codes](https://wiki.onap.org/).
17107       parameters:
17108         - name: global-customer-id
17109           in: path
17110           description: Global customer id used across ECOMP to uniquely identify customer.
17111           required: true
17112           type: string
17113           example: __GLOBAL-CUSTOMER-ID__
17114         - name: service-type
17115           in: path
17116           description: Value defined by orchestration to identify this service across ECOMP.
17117           required: true
17118           type: string
17119           example: __SERVICE-TYPE__
17120         - name: service-instance-id
17121           in: path
17122           description: Uniquely identifies this instance of a service
17123           required: true
17124           type: string
17125           example: __SERVICE-INSTANCE-ID__
17126         - name: id
17127           in: path
17128           description: Allotted Resource id UUID assigned to this instance.
17129           required: true
17130           type: string
17131           example: __ID__
17132         - name: id
17133           in: path
17134           description: Allotted Resource id UUID assigned to this instance.
17135           required: true
17136           type: string
17137           example: __ID__
17138         - name: body
17139           in: body
17140           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
17141           required: true
17142           schema:
17143             $ref: "#/definitions/relationship"
17144     delete:
17145       tags:
17146         - Business
17147       summary: delete an existing relationship
17148       description: delete an existing relationship
17149       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
17150       consumes:
17151         - application/json
17152         - application/xml
17153       produces:
17154         - application/json
17155         - application/xml
17156       responses:
17157         "default":
17158           description: Response codes found in [response codes](https://wiki.onap.org/).
17159       parameters:
17160         - name: global-customer-id
17161           in: path
17162           description: Global customer id used across ECOMP to uniquely identify customer.
17163           required: true
17164           type: string
17165           example: __GLOBAL-CUSTOMER-ID__
17166         - name: service-type
17167           in: path
17168           description: Value defined by orchestration to identify this service across ECOMP.
17169           required: true
17170           type: string
17171           example: __SERVICE-TYPE__
17172         - name: service-instance-id
17173           in: path
17174           description: Uniquely identifies this instance of a service
17175           required: true
17176           type: string
17177           example: __SERVICE-INSTANCE-ID__
17178         - name: id
17179           in: path
17180           description: Allotted Resource id UUID assigned to this instance.
17181           required: true
17182           type: string
17183           example: __ID__
17184         - name: id
17185           in: path
17186           description: Allotted Resource id UUID assigned to this instance.
17187           required: true
17188           type: string
17189           example: __ID__
17190   /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}:
17191     get:
17192       tags:
17193         - Business
17194       summary: returns tunnel-xconnect
17195       description: returns tunnel-xconnect
17196       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17197       produces:
17198         - application/json
17199         - application/xml
17200       responses:
17201         "200":
17202           description: successful operation
17203           schema:
17204               $ref: "#/getDefinitions/tunnel-xconnect"
17205         "default":
17206           description: Response codes found in [response codes](https://wiki.onap.org/).
17207       parameters:
17208         - name: global-customer-id
17209           in: path
17210           description: Global customer id used across ECOMP to uniquely identify customer.
17211           required: true
17212           type: string
17213           example: __GLOBAL-CUSTOMER-ID__
17214         - name: service-type
17215           in: path
17216           description: Value defined by orchestration to identify this service across ECOMP.
17217           required: true
17218           type: string
17219           example: __SERVICE-TYPE__
17220         - name: service-instance-id
17221           in: path
17222           description: Uniquely identifies this instance of a service
17223           required: true
17224           type: string
17225           example: __SERVICE-INSTANCE-ID__
17226         - name: id
17227           in: path
17228           description: Allotted Resource id UUID assigned to this instance.
17229           required: true
17230           type: string
17231           example: __ID__
17232         - name: id
17233           in: path
17234           description: Allotted Resource id UUID assigned to this instance.
17235           required: true
17236           type: string
17237           example: __ID__
17238         - name: subscriber-name
17239           in: query
17240           description: Subscriber name, an alternate way to retrieve a customer.
17241           required: false
17242           type: string
17243         - name: subscriber-type
17244           in: query
17245           description: Subscriber type, a way to provide VID with only the INFRA customers.
17246           required: false
17247           type: string
17248         - name: service-instance-name
17249           in: query
17250           description: This field will store a name assigned to the service-instance.
17251           required: false
17252           type: string
17253         - name: environment-context
17254           in: query
17255           description: This field will store the environment context assigned to the service-instance.
17256           required: false
17257           type: string
17258         - name: workload-context
17259           in: query
17260           description: This field will store the workload context assigned to the service-instance.
17261           required: false
17262           type: string
17263         - name: model-invariant-id
17264           in: query
17265           description: the ASDC model id for this resource or service model.
17266           required: false
17267           type: string
17268         - name: model-version-id
17269           in: query
17270           description: the ASDC model version for this resource or service model.
17271           required: false
17272           type: string
17273         - name: widget-model-id
17274           in: query
17275           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17276           required: false
17277           type: string
17278         - name: widget-model-version
17279           in: query
17280           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17281           required: false
17282           type: string
17283         - name: service-instance-location-id
17284           in: query
17285           description: An identifier that customers assign to the location where this service is being used.
17286           required: false
17287           type: string
17288         - name: orchestration-status
17289           in: query
17290           description: Orchestration status of this service.
17291           required: false
17292           type: string
17293         - name: model-invariant-id
17294           in: query
17295           description: the ASDC model id for this resource or service model.
17296           required: false
17297           type: string
17298         - name: model-version-id
17299           in: query
17300           description: the ASDC model version for this resource or service model.
17301           required: false
17302           type: string
17303         - name: type
17304           in: query
17305           description: Generic description of the type of allotted resource.
17306           required: false
17307           type: string
17308         - name: role
17309           in: query
17310           description: role in the network that this resource will be providing.
17311           required: false
17312           type: string
17313     put:
17314       tags:
17315         - Business
17316       summary: create or update an existing tunnel-xconnect
17317       description: |
17318         Create or update an existing tunnel-xconnect.
17319         #
17320         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
17321       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17322       consumes:
17323         - application/json
17324         - application/xml
17325       produces:
17326         - application/json
17327         - application/xml
17328       responses:
17329         "default":
17330           description: Response codes found in [response codes](https://wiki.onap.org/).
17331       parameters:
17332         - name: global-customer-id
17333           in: path
17334           description: Global customer id used across ECOMP to uniquely identify customer.
17335           required: true
17336           type: string
17337           example: __GLOBAL-CUSTOMER-ID__
17338         - name: service-type
17339           in: path
17340           description: Value defined by orchestration to identify this service across ECOMP.
17341           required: true
17342           type: string
17343           example: __SERVICE-TYPE__
17344         - name: service-instance-id
17345           in: path
17346           description: Uniquely identifies this instance of a service
17347           required: true
17348           type: string
17349           example: __SERVICE-INSTANCE-ID__
17350         - name: id
17351           in: path
17352           description: Allotted Resource id UUID assigned to this instance.
17353           required: true
17354           type: string
17355           example: __ID__
17356         - name: id
17357           in: path
17358           description: Allotted Resource id UUID assigned to this instance.
17359           required: true
17360           type: string
17361           example: __ID__
17362         - name: body
17363           in: body
17364           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
17365           required: true
17366           schema:
17367             $ref: "#/definitions/tunnel-xconnect"
17368     patch:
17369       tags:
17370         - Business
17371       summary: update an existing tunnel-xconnect
17372       description: |
17373         Update an existing tunnel-xconnect
17374         #
17375         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17376         The PUT operation will entirely replace an existing object.
17377         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.
17378         #
17379         Other differences between PUT and PATCH are:
17380         #
17381         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17382         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17383         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17384       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17385       consumes:
17386         - application/json
17387         - application/xml
17388       produces:
17389         - application/json
17390         - application/xml
17391       responses:
17392         "default":
17393           description: Response codes found in [response codes](https://wiki.onap.org/).
17394       parameters:
17395         - name: global-customer-id
17396           in: path
17397           description: Global customer id used across ECOMP to uniquely identify customer.
17398           required: true
17399           type: string
17400           example: __GLOBAL-CUSTOMER-ID__
17401         - name: service-type
17402           in: path
17403           description: Value defined by orchestration to identify this service across ECOMP.
17404           required: true
17405           type: string
17406           example: __SERVICE-TYPE__
17407         - name: service-instance-id
17408           in: path
17409           description: Uniquely identifies this instance of a service
17410           required: true
17411           type: string
17412           example: __SERVICE-INSTANCE-ID__
17413         - name: id
17414           in: path
17415           description: Allotted Resource id UUID assigned to this instance.
17416           required: true
17417           type: string
17418           example: __ID__
17419         - name: id
17420           in: path
17421           description: Allotted Resource id UUID assigned to this instance.
17422           required: true
17423           type: string
17424           example: __ID__
17425         - name: body
17426           in: body
17427           description: tunnel-xconnect object that needs to be created or updated.
17428           required: true
17429           schema:
17430             $ref: "#/patchDefinitions/tunnel-xconnect"
17431     delete:
17432       tags:
17433         - Business
17434       summary: delete an existing tunnel-xconnect
17435       description: delete an existing tunnel-xconnect
17436       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
17437       consumes:
17438         - application/json
17439         - application/xml
17440       produces:
17441         - application/json
17442         - application/xml
17443       responses:
17444         "default":
17445           description: Response codes found in [response codes](https://wiki.onap.org/).
17446       parameters:
17447         - name: global-customer-id
17448           in: path
17449           description: Global customer id used across ECOMP to uniquely identify customer.
17450           required: true
17451           type: string
17452           example: __GLOBAL-CUSTOMER-ID__
17453         - name: service-type
17454           in: path
17455           description: Value defined by orchestration to identify this service across ECOMP.
17456           required: true
17457           type: string
17458           example: __SERVICE-TYPE__
17459         - name: service-instance-id
17460           in: path
17461           description: Uniquely identifies this instance of a service
17462           required: true
17463           type: string
17464           example: __SERVICE-INSTANCE-ID__
17465         - name: id
17466           in: path
17467           description: Allotted Resource id UUID assigned to this instance.
17468           required: true
17469           type: string
17470           example: __ID__
17471         - name: id
17472           in: path
17473           description: Allotted Resource id UUID assigned to this instance.
17474           required: true
17475           type: string
17476           example: __ID__
17477         - name: resource-version
17478           in: query
17479           description: resource-version for concurrency
17480           required: true
17481           type: string
17482   /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:
17483     get:
17484       tags:
17485         - Business
17486       summary: returns tunnel-xconnects
17487       description: returns tunnel-xconnects
17488       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
17489       produces:
17490         - application/json
17491         - application/xml
17492       responses:
17493         "200":
17494           description: successful operation
17495           schema:
17496               $ref: "#/getDefinitions/tunnel-xconnects"
17497         "default":
17498           description: Response codes found in [response codes](https://wiki.onap.org/).
17499       parameters:
17500         - name: global-customer-id
17501           in: path
17502           description: Global customer id used across ECOMP to uniquely identify customer.
17503           required: true
17504           type: string
17505           example: __GLOBAL-CUSTOMER-ID__
17506         - name: service-type
17507           in: path
17508           description: Value defined by orchestration to identify this service across ECOMP.
17509           required: true
17510           type: string
17511           example: __SERVICE-TYPE__
17512         - name: service-instance-id
17513           in: path
17514           description: Uniquely identifies this instance of a service
17515           required: true
17516           type: string
17517           example: __SERVICE-INSTANCE-ID__
17518         - name: id
17519           in: path
17520           description: Allotted Resource id UUID assigned to this instance.
17521           required: true
17522           type: string
17523           example: __ID__
17524         - name: subscriber-name
17525           in: query
17526           description: Subscriber name, an alternate way to retrieve a customer.
17527           required: false
17528           type: string
17529         - name: subscriber-type
17530           in: query
17531           description: Subscriber type, a way to provide VID with only the INFRA customers.
17532           required: false
17533           type: string
17534         - name: service-instance-name
17535           in: query
17536           description: This field will store a name assigned to the service-instance.
17537           required: false
17538           type: string
17539         - name: environment-context
17540           in: query
17541           description: This field will store the environment context assigned to the service-instance.
17542           required: false
17543           type: string
17544         - name: workload-context
17545           in: query
17546           description: This field will store the workload context assigned to the service-instance.
17547           required: false
17548           type: string
17549         - name: model-invariant-id
17550           in: query
17551           description: the ASDC model id for this resource or service model.
17552           required: false
17553           type: string
17554         - name: model-version-id
17555           in: query
17556           description: the ASDC model version for this resource or service model.
17557           required: false
17558           type: string
17559         - name: widget-model-id
17560           in: query
17561           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17562           required: false
17563           type: string
17564         - name: widget-model-version
17565           in: query
17566           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17567           required: false
17568           type: string
17569         - name: service-instance-location-id
17570           in: query
17571           description: An identifier that customers assign to the location where this service is being used.
17572           required: false
17573           type: string
17574         - name: orchestration-status
17575           in: query
17576           description: Orchestration status of this service.
17577           required: false
17578           type: string
17579         - name: model-invariant-id
17580           in: query
17581           description: the ASDC model id for this resource or service model.
17582           required: false
17583           type: string
17584         - name: model-version-id
17585           in: query
17586           description: the ASDC model version for this resource or service model.
17587           required: false
17588           type: string
17589         - name: type
17590           in: query
17591           description: Generic description of the type of allotted resource.
17592           required: false
17593           type: string
17594         - name: role
17595           in: query
17596           description: role in the network that this resource will be providing.
17597           required: false
17598           type: string
17599   /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:
17600     put:
17601       tags:
17602         - Business
17603       summary: see node definition for valid relationships
17604       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
17605       consumes:
17606         - application/json
17607         - application/xml
17608       produces:
17609         - application/json
17610         - application/xml
17611       responses:
17612         "default":
17613           description: Response codes found in [response codes](https://wiki.onap.org/).
17614       parameters:
17615         - name: global-customer-id
17616           in: path
17617           description: Global customer id used across ECOMP to uniquely identify customer.
17618           required: true
17619           type: string
17620           example: __GLOBAL-CUSTOMER-ID__
17621         - name: service-type
17622           in: path
17623           description: Value defined by orchestration to identify this service across ECOMP.
17624           required: true
17625           type: string
17626           example: __SERVICE-TYPE__
17627         - name: service-instance-id
17628           in: path
17629           description: Uniquely identifies this instance of a service
17630           required: true
17631           type: string
17632           example: __SERVICE-INSTANCE-ID__
17633         - name: id
17634           in: path
17635           description: Allotted Resource id UUID assigned to this instance.
17636           required: true
17637           type: string
17638           example: __ID__
17639         - name: body
17640           in: body
17641           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
17642           required: true
17643           schema:
17644             $ref: "#/definitions/relationship"
17645     delete:
17646       tags:
17647         - Business
17648       summary: delete an existing relationship
17649       description: delete an existing relationship
17650       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
17651       consumes:
17652         - application/json
17653         - application/xml
17654       produces:
17655         - application/json
17656         - application/xml
17657       responses:
17658         "default":
17659           description: Response codes found in [response codes](https://wiki.onap.org/).
17660       parameters:
17661         - name: global-customer-id
17662           in: path
17663           description: Global customer id used across ECOMP to uniquely identify customer.
17664           required: true
17665           type: string
17666           example: __GLOBAL-CUSTOMER-ID__
17667         - name: service-type
17668           in: path
17669           description: Value defined by orchestration to identify this service across ECOMP.
17670           required: true
17671           type: string
17672           example: __SERVICE-TYPE__
17673         - name: service-instance-id
17674           in: path
17675           description: Uniquely identifies this instance of a service
17676           required: true
17677           type: string
17678           example: __SERVICE-INSTANCE-ID__
17679         - name: id
17680           in: path
17681           description: Allotted Resource id UUID assigned to this instance.
17682           required: true
17683           type: string
17684           example: __ID__
17685   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
17686     get:
17687       tags:
17688         - Business
17689       summary: returns allotted-resource
17690       description: returns allotted-resource
17691       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17692       produces:
17693         - application/json
17694         - application/xml
17695       responses:
17696         "200":
17697           description: successful operation
17698           schema:
17699               $ref: "#/getDefinitions/allotted-resource"
17700         "default":
17701           description: Response codes found in [response codes](https://wiki.onap.org/).
17702       parameters:
17703         - name: global-customer-id
17704           in: path
17705           description: Global customer id used across ECOMP to uniquely identify customer.
17706           required: true
17707           type: string
17708           example: __GLOBAL-CUSTOMER-ID__
17709         - name: service-type
17710           in: path
17711           description: Value defined by orchestration to identify this service across ECOMP.
17712           required: true
17713           type: string
17714           example: __SERVICE-TYPE__
17715         - name: service-instance-id
17716           in: path
17717           description: Uniquely identifies this instance of a service
17718           required: true
17719           type: string
17720           example: __SERVICE-INSTANCE-ID__
17721         - name: id
17722           in: path
17723           description: Allotted Resource id UUID assigned to this instance.
17724           required: true
17725           type: string
17726           example: __ID__
17727         - name: subscriber-name
17728           in: query
17729           description: Subscriber name, an alternate way to retrieve a customer.
17730           required: false
17731           type: string
17732         - name: subscriber-type
17733           in: query
17734           description: Subscriber type, a way to provide VID with only the INFRA customers.
17735           required: false
17736           type: string
17737         - name: service-instance-name
17738           in: query
17739           description: This field will store a name assigned to the service-instance.
17740           required: false
17741           type: string
17742         - name: environment-context
17743           in: query
17744           description: This field will store the environment context assigned to the service-instance.
17745           required: false
17746           type: string
17747         - name: workload-context
17748           in: query
17749           description: This field will store the workload context assigned to the service-instance.
17750           required: false
17751           type: string
17752         - name: model-invariant-id
17753           in: query
17754           description: the ASDC model id for this resource or service model.
17755           required: false
17756           type: string
17757         - name: model-version-id
17758           in: query
17759           description: the ASDC model version for this resource or service model.
17760           required: false
17761           type: string
17762         - name: widget-model-id
17763           in: query
17764           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17765           required: false
17766           type: string
17767         - name: widget-model-version
17768           in: query
17769           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17770           required: false
17771           type: string
17772         - name: service-instance-location-id
17773           in: query
17774           description: An identifier that customers assign to the location where this service is being used.
17775           required: false
17776           type: string
17777         - name: orchestration-status
17778           in: query
17779           description: Orchestration status of this service.
17780           required: false
17781           type: string
17782         - name: model-invariant-id
17783           in: query
17784           description: the ASDC model id for this resource or service model.
17785           required: false
17786           type: string
17787         - name: model-version-id
17788           in: query
17789           description: the ASDC model version for this resource or service model.
17790           required: false
17791           type: string
17792         - name: type
17793           in: query
17794           description: Generic description of the type of allotted resource.
17795           required: false
17796           type: string
17797         - name: role
17798           in: query
17799           description: role in the network that this resource will be providing.
17800           required: false
17801           type: string
17802     put:
17803       tags:
17804         - Business
17805       summary: create or update an existing allotted-resource
17806       description: |
17807         Create or update an existing allotted-resource.
17808         #
17809         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
17810       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17811       consumes:
17812         - application/json
17813         - application/xml
17814       produces:
17815         - application/json
17816         - application/xml
17817       responses:
17818         "default":
17819           description: Response codes found in [response codes](https://wiki.onap.org/).
17820       parameters:
17821         - name: global-customer-id
17822           in: path
17823           description: Global customer id used across ECOMP to uniquely identify customer.
17824           required: true
17825           type: string
17826           example: __GLOBAL-CUSTOMER-ID__
17827         - name: service-type
17828           in: path
17829           description: Value defined by orchestration to identify this service across ECOMP.
17830           required: true
17831           type: string
17832           example: __SERVICE-TYPE__
17833         - name: service-instance-id
17834           in: path
17835           description: Uniquely identifies this instance of a service
17836           required: true
17837           type: string
17838           example: __SERVICE-INSTANCE-ID__
17839         - name: id
17840           in: path
17841           description: Allotted Resource id UUID assigned to this instance.
17842           required: true
17843           type: string
17844           example: __ID__
17845         - name: body
17846           in: body
17847           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
17848           required: true
17849           schema:
17850             $ref: "#/definitions/allotted-resource"
17851     patch:
17852       tags:
17853         - Business
17854       summary: update an existing allotted-resource
17855       description: |
17856         Update an existing allotted-resource
17857         #
17858         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17859         The PUT operation will entirely replace an existing object.
17860         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.
17861         #
17862         Other differences between PUT and PATCH are:
17863         #
17864         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17865         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17866         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17867       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17868       consumes:
17869         - application/json
17870         - application/xml
17871       produces:
17872         - application/json
17873         - application/xml
17874       responses:
17875         "default":
17876           description: Response codes found in [response codes](https://wiki.onap.org/).
17877       parameters:
17878         - name: global-customer-id
17879           in: path
17880           description: Global customer id used across ECOMP to uniquely identify customer.
17881           required: true
17882           type: string
17883           example: __GLOBAL-CUSTOMER-ID__
17884         - name: service-type
17885           in: path
17886           description: Value defined by orchestration to identify this service across ECOMP.
17887           required: true
17888           type: string
17889           example: __SERVICE-TYPE__
17890         - name: service-instance-id
17891           in: path
17892           description: Uniquely identifies this instance of a service
17893           required: true
17894           type: string
17895           example: __SERVICE-INSTANCE-ID__
17896         - name: id
17897           in: path
17898           description: Allotted Resource id UUID assigned to this instance.
17899           required: true
17900           type: string
17901           example: __ID__
17902         - name: body
17903           in: body
17904           description: allotted-resource object that needs to be created or updated.
17905           required: true
17906           schema:
17907             $ref: "#/patchDefinitions/allotted-resource"
17908     delete:
17909       tags:
17910         - Business
17911       summary: delete an existing allotted-resource
17912       description: delete an existing allotted-resource
17913       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17914       consumes:
17915         - application/json
17916         - application/xml
17917       produces:
17918         - application/json
17919         - application/xml
17920       responses:
17921         "default":
17922           description: Response codes found in [response codes](https://wiki.onap.org/).
17923       parameters:
17924         - name: global-customer-id
17925           in: path
17926           description: Global customer id used across ECOMP to uniquely identify customer.
17927           required: true
17928           type: string
17929           example: __GLOBAL-CUSTOMER-ID__
17930         - name: service-type
17931           in: path
17932           description: Value defined by orchestration to identify this service across ECOMP.
17933           required: true
17934           type: string
17935           example: __SERVICE-TYPE__
17936         - name: service-instance-id
17937           in: path
17938           description: Uniquely identifies this instance of a service
17939           required: true
17940           type: string
17941           example: __SERVICE-INSTANCE-ID__
17942         - name: id
17943           in: path
17944           description: Allotted Resource id UUID assigned to this instance.
17945           required: true
17946           type: string
17947           example: __ID__
17948         - name: resource-version
17949           in: query
17950           description: resource-version for concurrency
17951           required: true
17952           type: string
17953   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
17954     get:
17955       tags:
17956         - Business
17957       summary: returns allotted-resources
17958       description: returns allotted-resources
17959       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
17960       produces:
17961         - application/json
17962         - application/xml
17963       responses:
17964         "200":
17965           description: successful operation
17966           schema:
17967               $ref: "#/getDefinitions/allotted-resources"
17968         "default":
17969           description: Response codes found in [response codes](https://wiki.onap.org/).
17970       parameters:
17971         - name: global-customer-id
17972           in: path
17973           description: Global customer id used across ECOMP to uniquely identify customer.
17974           required: true
17975           type: string
17976           example: __GLOBAL-CUSTOMER-ID__
17977         - name: service-type
17978           in: path
17979           description: Value defined by orchestration to identify this service across ECOMP.
17980           required: true
17981           type: string
17982           example: __SERVICE-TYPE__
17983         - name: service-instance-id
17984           in: path
17985           description: Uniquely identifies this instance of a service
17986           required: true
17987           type: string
17988           example: __SERVICE-INSTANCE-ID__
17989         - name: subscriber-name
17990           in: query
17991           description: Subscriber name, an alternate way to retrieve a customer.
17992           required: false
17993           type: string
17994         - name: subscriber-type
17995           in: query
17996           description: Subscriber type, a way to provide VID with only the INFRA customers.
17997           required: false
17998           type: string
17999         - name: service-instance-name
18000           in: query
18001           description: This field will store a name assigned to the service-instance.
18002           required: false
18003           type: string
18004         - name: environment-context
18005           in: query
18006           description: This field will store the environment context assigned to the service-instance.
18007           required: false
18008           type: string
18009         - name: workload-context
18010           in: query
18011           description: This field will store the workload context assigned to the service-instance.
18012           required: false
18013           type: string
18014         - name: model-invariant-id
18015           in: query
18016           description: the ASDC model id for this resource or service model.
18017           required: false
18018           type: string
18019         - name: model-version-id
18020           in: query
18021           description: the ASDC model version for this resource or service model.
18022           required: false
18023           type: string
18024         - name: widget-model-id
18025           in: query
18026           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18027           required: false
18028           type: string
18029         - name: widget-model-version
18030           in: query
18031           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18032           required: false
18033           type: string
18034         - name: service-instance-location-id
18035           in: query
18036           description: An identifier that customers assign to the location where this service is being used.
18037           required: false
18038           type: string
18039         - name: orchestration-status
18040           in: query
18041           description: Orchestration status of this service.
18042           required: false
18043           type: string
18044   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
18045     get:
18046       tags:
18047         - Business
18048       summary: returns service-instance
18049       description: returns service-instance
18050       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18051       produces:
18052         - application/json
18053         - application/xml
18054       responses:
18055         "200":
18056           description: successful operation
18057           schema:
18058               $ref: "#/getDefinitions/service-instance"
18059         "default":
18060           description: Response codes found in [response codes](https://wiki.onap.org/).
18061       parameters:
18062         - name: global-customer-id
18063           in: path
18064           description: Global customer id used across ECOMP to uniquely identify customer.
18065           required: true
18066           type: string
18067           example: __GLOBAL-CUSTOMER-ID__
18068         - name: service-type
18069           in: path
18070           description: Value defined by orchestration to identify this service across ECOMP.
18071           required: true
18072           type: string
18073           example: __SERVICE-TYPE__
18074         - name: service-instance-id
18075           in: path
18076           description: Uniquely identifies this instance of a service
18077           required: true
18078           type: string
18079           example: __SERVICE-INSTANCE-ID__
18080         - name: subscriber-name
18081           in: query
18082           description: Subscriber name, an alternate way to retrieve a customer.
18083           required: false
18084           type: string
18085         - name: subscriber-type
18086           in: query
18087           description: Subscriber type, a way to provide VID with only the INFRA customers.
18088           required: false
18089           type: string
18090         - name: service-instance-name
18091           in: query
18092           description: This field will store a name assigned to the service-instance.
18093           required: false
18094           type: string
18095         - name: environment-context
18096           in: query
18097           description: This field will store the environment context assigned to the service-instance.
18098           required: false
18099           type: string
18100         - name: workload-context
18101           in: query
18102           description: This field will store the workload context assigned to the service-instance.
18103           required: false
18104           type: string
18105         - name: model-invariant-id
18106           in: query
18107           description: the ASDC model id for this resource or service model.
18108           required: false
18109           type: string
18110         - name: model-version-id
18111           in: query
18112           description: the ASDC model version for this resource or service model.
18113           required: false
18114           type: string
18115         - name: widget-model-id
18116           in: query
18117           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18118           required: false
18119           type: string
18120         - name: widget-model-version
18121           in: query
18122           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18123           required: false
18124           type: string
18125         - name: service-instance-location-id
18126           in: query
18127           description: An identifier that customers assign to the location where this service is being used.
18128           required: false
18129           type: string
18130         - name: orchestration-status
18131           in: query
18132           description: Orchestration status of this service.
18133           required: false
18134           type: string
18135     put:
18136       tags:
18137         - Business
18138       summary: create or update an existing service-instance
18139       description: |
18140         Create or update an existing service-instance.
18141         #
18142         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
18143       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18144       consumes:
18145         - application/json
18146         - application/xml
18147       produces:
18148         - application/json
18149         - application/xml
18150       responses:
18151         "default":
18152           description: Response codes found in [response codes](https://wiki.onap.org/).
18153       parameters:
18154         - name: global-customer-id
18155           in: path
18156           description: Global customer id used across ECOMP to uniquely identify customer.
18157           required: true
18158           type: string
18159           example: __GLOBAL-CUSTOMER-ID__
18160         - name: service-type
18161           in: path
18162           description: Value defined by orchestration to identify this service across ECOMP.
18163           required: true
18164           type: string
18165           example: __SERVICE-TYPE__
18166         - name: service-instance-id
18167           in: path
18168           description: Uniquely identifies this instance of a service
18169           required: true
18170           type: string
18171           example: __SERVICE-INSTANCE-ID__
18172         - name: body
18173           in: body
18174           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
18175           required: true
18176           schema:
18177             $ref: "#/definitions/service-instance"
18178     patch:
18179       tags:
18180         - Business
18181       summary: update an existing service-instance
18182       description: |
18183         Update an existing service-instance
18184         #
18185         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18186         The PUT operation will entirely replace an existing object.
18187         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.
18188         #
18189         Other differences between PUT and PATCH are:
18190         #
18191         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18192         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18193         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18194       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18195       consumes:
18196         - application/json
18197         - application/xml
18198       produces:
18199         - application/json
18200         - application/xml
18201       responses:
18202         "default":
18203           description: Response codes found in [response codes](https://wiki.onap.org/).
18204       parameters:
18205         - name: global-customer-id
18206           in: path
18207           description: Global customer id used across ECOMP to uniquely identify customer.
18208           required: true
18209           type: string
18210           example: __GLOBAL-CUSTOMER-ID__
18211         - name: service-type
18212           in: path
18213           description: Value defined by orchestration to identify this service across ECOMP.
18214           required: true
18215           type: string
18216           example: __SERVICE-TYPE__
18217         - name: service-instance-id
18218           in: path
18219           description: Uniquely identifies this instance of a service
18220           required: true
18221           type: string
18222           example: __SERVICE-INSTANCE-ID__
18223         - name: body
18224           in: body
18225           description: service-instance object that needs to be created or updated.
18226           required: true
18227           schema:
18228             $ref: "#/patchDefinitions/service-instance"
18229     delete:
18230       tags:
18231         - Business
18232       summary: delete an existing service-instance
18233       description: delete an existing service-instance
18234       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
18235       consumes:
18236         - application/json
18237         - application/xml
18238       produces:
18239         - application/json
18240         - application/xml
18241       responses:
18242         "default":
18243           description: Response codes found in [response codes](https://wiki.onap.org/).
18244       parameters:
18245         - name: global-customer-id
18246           in: path
18247           description: Global customer id used across ECOMP to uniquely identify customer.
18248           required: true
18249           type: string
18250           example: __GLOBAL-CUSTOMER-ID__
18251         - name: service-type
18252           in: path
18253           description: Value defined by orchestration to identify this service across ECOMP.
18254           required: true
18255           type: string
18256           example: __SERVICE-TYPE__
18257         - name: service-instance-id
18258           in: path
18259           description: Uniquely identifies this instance of a service
18260           required: true
18261           type: string
18262           example: __SERVICE-INSTANCE-ID__
18263         - name: resource-version
18264           in: query
18265           description: resource-version for concurrency
18266           required: true
18267           type: string
18268   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
18269     get:
18270       tags:
18271         - Business
18272       summary: returns service-instances
18273       description: returns service-instances
18274       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
18275       produces:
18276         - application/json
18277         - application/xml
18278       responses:
18279         "200":
18280           description: successful operation
18281           schema:
18282               $ref: "#/getDefinitions/service-instances"
18283         "default":
18284           description: Response codes found in [response codes](https://wiki.onap.org/).
18285       parameters:
18286         - name: global-customer-id
18287           in: path
18288           description: Global customer id used across ECOMP to uniquely identify customer.
18289           required: true
18290           type: string
18291           example: __GLOBAL-CUSTOMER-ID__
18292         - name: service-type
18293           in: path
18294           description: Value defined by orchestration to identify this service across ECOMP.
18295           required: true
18296           type: string
18297           example: __SERVICE-TYPE__
18298         - name: subscriber-name
18299           in: query
18300           description: Subscriber name, an alternate way to retrieve a customer.
18301           required: false
18302           type: string
18303         - name: subscriber-type
18304           in: query
18305           description: Subscriber type, a way to provide VID with only the INFRA customers.
18306           required: false
18307           type: string
18308   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
18309     put:
18310       tags:
18311         - Business
18312       summary: see node definition for valid relationships
18313       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
18314       consumes:
18315         - application/json
18316         - application/xml
18317       produces:
18318         - application/json
18319         - application/xml
18320       responses:
18321         "default":
18322           description: Response codes found in [response codes](https://wiki.onap.org/).
18323       parameters:
18324         - name: global-customer-id
18325           in: path
18326           description: Global customer id used across ECOMP to uniquely identify customer.
18327           required: true
18328           type: string
18329           example: __GLOBAL-CUSTOMER-ID__
18330         - name: service-type
18331           in: path
18332           description: Value defined by orchestration to identify this service across ECOMP.
18333           required: true
18334           type: string
18335           example: __SERVICE-TYPE__
18336         - name: body
18337           in: body
18338           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
18339           required: true
18340           schema:
18341             $ref: "#/definitions/relationship"
18342     delete:
18343       tags:
18344         - Business
18345       summary: delete an existing relationship
18346       description: delete an existing relationship
18347       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
18348       consumes:
18349         - application/json
18350         - application/xml
18351       produces:
18352         - application/json
18353         - application/xml
18354       responses:
18355         "default":
18356           description: Response codes found in [response codes](https://wiki.onap.org/).
18357       parameters:
18358         - name: global-customer-id
18359           in: path
18360           description: Global customer id used across ECOMP to uniquely identify customer.
18361           required: true
18362           type: string
18363           example: __GLOBAL-CUSTOMER-ID__
18364         - name: service-type
18365           in: path
18366           description: Value defined by orchestration to identify this service across ECOMP.
18367           required: true
18368           type: string
18369           example: __SERVICE-TYPE__
18370   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
18371     get:
18372       tags:
18373         - Business
18374       summary: returns service-subscription
18375       description: returns service-subscription
18376       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18377       produces:
18378         - application/json
18379         - application/xml
18380       responses:
18381         "200":
18382           description: successful operation
18383           schema:
18384               $ref: "#/getDefinitions/service-subscription"
18385         "default":
18386           description: Response codes found in [response codes](https://wiki.onap.org/).
18387       parameters:
18388         - name: global-customer-id
18389           in: path
18390           description: Global customer id used across ECOMP to uniquely identify customer.
18391           required: true
18392           type: string
18393           example: __GLOBAL-CUSTOMER-ID__
18394         - name: service-type
18395           in: path
18396           description: Value defined by orchestration to identify this service across ECOMP.
18397           required: true
18398           type: string
18399           example: __SERVICE-TYPE__
18400         - name: subscriber-name
18401           in: query
18402           description: Subscriber name, an alternate way to retrieve a customer.
18403           required: false
18404           type: string
18405         - name: subscriber-type
18406           in: query
18407           description: Subscriber type, a way to provide VID with only the INFRA customers.
18408           required: false
18409           type: string
18410     put:
18411       tags:
18412         - Business
18413       summary: create or update an existing service-subscription
18414       description: |
18415         Create or update an existing service-subscription.
18416         #
18417         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
18418       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18419       consumes:
18420         - application/json
18421         - application/xml
18422       produces:
18423         - application/json
18424         - application/xml
18425       responses:
18426         "default":
18427           description: Response codes found in [response codes](https://wiki.onap.org/).
18428       parameters:
18429         - name: global-customer-id
18430           in: path
18431           description: Global customer id used across ECOMP to uniquely identify customer.
18432           required: true
18433           type: string
18434           example: __GLOBAL-CUSTOMER-ID__
18435         - name: service-type
18436           in: path
18437           description: Value defined by orchestration to identify this service across ECOMP.
18438           required: true
18439           type: string
18440           example: __SERVICE-TYPE__
18441         - name: body
18442           in: body
18443           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
18444           required: true
18445           schema:
18446             $ref: "#/definitions/service-subscription"
18447     patch:
18448       tags:
18449         - Business
18450       summary: update an existing service-subscription
18451       description: |
18452         Update an existing service-subscription
18453         #
18454         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18455         The PUT operation will entirely replace an existing object.
18456         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.
18457         #
18458         Other differences between PUT and PATCH are:
18459         #
18460         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18461         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18462         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18463       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18464       consumes:
18465         - application/json
18466         - application/xml
18467       produces:
18468         - application/json
18469         - application/xml
18470       responses:
18471         "default":
18472           description: Response codes found in [response codes](https://wiki.onap.org/).
18473       parameters:
18474         - name: global-customer-id
18475           in: path
18476           description: Global customer id used across ECOMP to uniquely identify customer.
18477           required: true
18478           type: string
18479           example: __GLOBAL-CUSTOMER-ID__
18480         - name: service-type
18481           in: path
18482           description: Value defined by orchestration to identify this service across ECOMP.
18483           required: true
18484           type: string
18485           example: __SERVICE-TYPE__
18486         - name: body
18487           in: body
18488           description: service-subscription object that needs to be created or updated.
18489           required: true
18490           schema:
18491             $ref: "#/patchDefinitions/service-subscription"
18492     delete:
18493       tags:
18494         - Business
18495       summary: delete an existing service-subscription
18496       description: delete an existing service-subscription
18497       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
18498       consumes:
18499         - application/json
18500         - application/xml
18501       produces:
18502         - application/json
18503         - application/xml
18504       responses:
18505         "default":
18506           description: Response codes found in [response codes](https://wiki.onap.org/).
18507       parameters:
18508         - name: global-customer-id
18509           in: path
18510           description: Global customer id used across ECOMP to uniquely identify customer.
18511           required: true
18512           type: string
18513           example: __GLOBAL-CUSTOMER-ID__
18514         - name: service-type
18515           in: path
18516           description: Value defined by orchestration to identify this service across ECOMP.
18517           required: true
18518           type: string
18519           example: __SERVICE-TYPE__
18520         - name: resource-version
18521           in: query
18522           description: resource-version for concurrency
18523           required: true
18524           type: string
18525   /business/customers/customer/{global-customer-id}/service-subscriptions:
18526     get:
18527       tags:
18528         - Business
18529       summary: returns service-subscriptions
18530       description: returns service-subscriptions
18531       operationId: getBusinessCustomersCustomerServiceSubscriptions
18532       produces:
18533         - application/json
18534         - application/xml
18535       responses:
18536         "200":
18537           description: successful operation
18538           schema:
18539               $ref: "#/getDefinitions/service-subscriptions"
18540         "default":
18541           description: Response codes found in [response codes](https://wiki.onap.org/).
18542       parameters:
18543         - name: global-customer-id
18544           in: path
18545           description: Global customer id used across ECOMP to uniquely identify customer.
18546           required: true
18547           type: string
18548           example: __GLOBAL-CUSTOMER-ID__
18549         - name: subscriber-name
18550           in: query
18551           description: Subscriber name, an alternate way to retrieve a customer.
18552           required: false
18553           type: string
18554         - name: subscriber-type
18555           in: query
18556           description: Subscriber type, a way to provide VID with only the INFRA customers.
18557           required: false
18558           type: string
18559   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
18560     put:
18561       tags:
18562         - Business
18563       summary: see node definition for valid relationships
18564       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
18565       consumes:
18566         - application/json
18567         - application/xml
18568       produces:
18569         - application/json
18570         - application/xml
18571       responses:
18572         "default":
18573           description: Response codes found in [response codes](https://wiki.onap.org/).
18574       parameters:
18575         - name: global-customer-id
18576           in: path
18577           description: Global customer id used across ECOMP to uniquely identify customer.
18578           required: true
18579           type: string
18580           example: __GLOBAL-CUSTOMER-ID__
18581         - name: body
18582           in: body
18583           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
18584           required: true
18585           schema:
18586             $ref: "#/definitions/relationship"
18587     delete:
18588       tags:
18589         - Business
18590       summary: delete an existing relationship
18591       description: delete an existing relationship
18592       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
18593       consumes:
18594         - application/json
18595         - application/xml
18596       produces:
18597         - application/json
18598         - application/xml
18599       responses:
18600         "default":
18601           description: Response codes found in [response codes](https://wiki.onap.org/).
18602       parameters:
18603         - name: global-customer-id
18604           in: path
18605           description: Global customer id used across ECOMP to uniquely identify customer.
18606           required: true
18607           type: string
18608           example: __GLOBAL-CUSTOMER-ID__
18609   /business/customers/customer/{global-customer-id}:
18610     get:
18611       tags:
18612         - Business
18613       summary: returns customer
18614       description: returns customer
18615       operationId: getBusinessCustomersCustomer
18616       produces:
18617         - application/json
18618         - application/xml
18619       responses:
18620         "200":
18621           description: successful operation
18622           schema:
18623               $ref: "#/getDefinitions/customer"
18624         "default":
18625           description: Response codes found in [response codes](https://wiki.onap.org/).
18626       parameters:
18627         - name: global-customer-id
18628           in: path
18629           description: Global customer id used across ECOMP to uniquely identify customer.
18630           required: true
18631           type: string
18632           example: __GLOBAL-CUSTOMER-ID__
18633         - name: subscriber-name
18634           in: query
18635           description: Subscriber name, an alternate way to retrieve a customer.
18636           required: false
18637           type: string
18638         - name: subscriber-type
18639           in: query
18640           description: Subscriber type, a way to provide VID with only the INFRA customers.
18641           required: false
18642           type: string
18643     put:
18644       tags:
18645         - Business
18646       summary: create or update an existing customer
18647       description: |
18648         Create or update an existing customer.
18649         #
18650         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
18651       operationId: createOrUpdateBusinessCustomersCustomer
18652       consumes:
18653         - application/json
18654         - application/xml
18655       produces:
18656         - application/json
18657         - application/xml
18658       responses:
18659         "default":
18660           description: Response codes found in [response codes](https://wiki.onap.org/).
18661       parameters:
18662         - name: global-customer-id
18663           in: path
18664           description: Global customer id used across ECOMP to uniquely identify customer.
18665           required: true
18666           type: string
18667           example: __GLOBAL-CUSTOMER-ID__
18668         - name: body
18669           in: body
18670           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
18671           required: true
18672           schema:
18673             $ref: "#/definitions/customer"
18674     patch:
18675       tags:
18676         - Business
18677       summary: update an existing customer
18678       description: |
18679         Update an existing customer
18680         #
18681         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18682         The PUT operation will entirely replace an existing object.
18683         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.
18684         #
18685         Other differences between PUT and PATCH are:
18686         #
18687         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18688         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18689         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18690       operationId: UpdateBusinessCustomersCustomer
18691       consumes:
18692         - application/json
18693         - application/xml
18694       produces:
18695         - application/json
18696         - application/xml
18697       responses:
18698         "default":
18699           description: Response codes found in [response codes](https://wiki.onap.org/).
18700       parameters:
18701         - name: global-customer-id
18702           in: path
18703           description: Global customer id used across ECOMP to uniquely identify customer.
18704           required: true
18705           type: string
18706           example: __GLOBAL-CUSTOMER-ID__
18707         - name: body
18708           in: body
18709           description: customer object that needs to be created or updated.
18710           required: true
18711           schema:
18712             $ref: "#/patchDefinitions/customer"
18713     delete:
18714       tags:
18715         - Business
18716       summary: delete an existing customer
18717       description: delete an existing customer
18718       operationId: deleteBusinessCustomersCustomer
18719       consumes:
18720         - application/json
18721         - application/xml
18722       produces:
18723         - application/json
18724         - application/xml
18725       responses:
18726         "default":
18727           description: Response codes found in [response codes](https://wiki.onap.org/).
18728       parameters:
18729         - name: global-customer-id
18730           in: path
18731           description: Global customer id used across ECOMP to uniquely identify customer.
18732           required: true
18733           type: string
18734           example: __GLOBAL-CUSTOMER-ID__
18735         - name: resource-version
18736           in: query
18737           description: resource-version for concurrency
18738           required: true
18739           type: string
18740   /business/customers:
18741     get:
18742       tags:
18743         - Business
18744       summary: returns customers
18745       description: returns customers
18746       operationId: getBusinessCustomers
18747       produces:
18748         - application/json
18749         - application/xml
18750       responses:
18751         "200":
18752           description: successful operation
18753           schema:
18754               $ref: "#/getDefinitions/customers"
18755         "default":
18756           description: Response codes found in [response codes](https://wiki.onap.org/).
18757   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
18758     put:
18759       tags:
18760         - Business
18761       summary: see node definition for valid relationships
18762       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
18763       consumes:
18764         - application/json
18765         - application/xml
18766       produces:
18767         - application/json
18768         - application/xml
18769       responses:
18770         "default":
18771           description: Response codes found in [response codes](https://wiki.onap.org/).
18772       parameters:
18773         - name: line-of-business-name
18774           in: path
18775           description: Name of the line-of-business (product)
18776           required: true
18777           type: string
18778           example: __LINE-OF-BUSINESS-NAME__
18779         - name: body
18780           in: body
18781           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
18782           required: true
18783           schema:
18784             $ref: "#/definitions/relationship"
18785     delete:
18786       tags:
18787         - Business
18788       summary: delete an existing relationship
18789       description: delete an existing relationship
18790       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
18791       consumes:
18792         - application/json
18793         - application/xml
18794       produces:
18795         - application/json
18796         - application/xml
18797       responses:
18798         "default":
18799           description: Response codes found in [response codes](https://wiki.onap.org/).
18800       parameters:
18801         - name: line-of-business-name
18802           in: path
18803           description: Name of the line-of-business (product)
18804           required: true
18805           type: string
18806           example: __LINE-OF-BUSINESS-NAME__
18807   /business/lines-of-business/line-of-business/{line-of-business-name}:
18808     get:
18809       tags:
18810         - Business
18811       summary: returns line-of-business
18812       description: returns line-of-business
18813       operationId: getBusinessLinesOfBusinessLineOfBusiness
18814       produces:
18815         - application/json
18816         - application/xml
18817       responses:
18818         "200":
18819           description: successful operation
18820           schema:
18821               $ref: "#/getDefinitions/line-of-business"
18822         "default":
18823           description: Response codes found in [response codes](https://wiki.onap.org/).
18824       parameters:
18825         - name: line-of-business-name
18826           in: path
18827           description: Name of the line-of-business (product)
18828           required: true
18829           type: string
18830           example: __LINE-OF-BUSINESS-NAME__
18831     put:
18832       tags:
18833         - Business
18834       summary: create or update an existing line-of-business
18835       description: |
18836         Create or update an existing line-of-business.
18837         #
18838         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
18839       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
18840       consumes:
18841         - application/json
18842         - application/xml
18843       produces:
18844         - application/json
18845         - application/xml
18846       responses:
18847         "default":
18848           description: Response codes found in [response codes](https://wiki.onap.org/).
18849       parameters:
18850         - name: line-of-business-name
18851           in: path
18852           description: Name of the line-of-business (product)
18853           required: true
18854           type: string
18855           example: __LINE-OF-BUSINESS-NAME__
18856         - name: body
18857           in: body
18858           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
18859           required: true
18860           schema:
18861             $ref: "#/definitions/line-of-business"
18862     patch:
18863       tags:
18864         - Business
18865       summary: update an existing line-of-business
18866       description: |
18867         Update an existing line-of-business
18868         #
18869         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18870         The PUT operation will entirely replace an existing object.
18871         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.
18872         #
18873         Other differences between PUT and PATCH are:
18874         #
18875         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18876         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18877         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18878       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
18879       consumes:
18880         - application/json
18881         - application/xml
18882       produces:
18883         - application/json
18884         - application/xml
18885       responses:
18886         "default":
18887           description: Response codes found in [response codes](https://wiki.onap.org/).
18888       parameters:
18889         - name: line-of-business-name
18890           in: path
18891           description: Name of the line-of-business (product)
18892           required: true
18893           type: string
18894           example: __LINE-OF-BUSINESS-NAME__
18895         - name: body
18896           in: body
18897           description: line-of-business object that needs to be created or updated.
18898           required: true
18899           schema:
18900             $ref: "#/patchDefinitions/line-of-business"
18901     delete:
18902       tags:
18903         - Business
18904       summary: delete an existing line-of-business
18905       description: delete an existing line-of-business
18906       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
18907       consumes:
18908         - application/json
18909         - application/xml
18910       produces:
18911         - application/json
18912         - application/xml
18913       responses:
18914         "default":
18915           description: Response codes found in [response codes](https://wiki.onap.org/).
18916       parameters:
18917         - name: line-of-business-name
18918           in: path
18919           description: Name of the line-of-business (product)
18920           required: true
18921           type: string
18922           example: __LINE-OF-BUSINESS-NAME__
18923         - name: resource-version
18924           in: query
18925           description: resource-version for concurrency
18926           required: true
18927           type: string
18928   /business/lines-of-business:
18929     get:
18930       tags:
18931         - Business
18932       summary: returns lines-of-business
18933       description: returns lines-of-business
18934       operationId: getBusinessLinesOfBusiness
18935       produces:
18936         - application/json
18937         - application/xml
18938       responses:
18939         "200":
18940           description: successful operation
18941           schema:
18942               $ref: "#/getDefinitions/lines-of-business"
18943         "default":
18944           description: Response codes found in [response codes](https://wiki.onap.org/).
18945   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
18946     put:
18947       tags:
18948         - Business
18949       summary: see node definition for valid relationships
18950       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18951       consumes:
18952         - application/json
18953         - application/xml
18954       produces:
18955         - application/json
18956         - application/xml
18957       responses:
18958         "default":
18959           description: Response codes found in [response codes](https://wiki.onap.org/).
18960       parameters:
18961         - name: owning-entity-id
18962           in: path
18963           description: UUID of an owning entity
18964           required: true
18965           type: string
18966           example: __OWNING-ENTITY-ID__
18967         - name: body
18968           in: body
18969           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
18970           required: true
18971           schema:
18972             $ref: "#/definitions/relationship"
18973     delete:
18974       tags:
18975         - Business
18976       summary: delete an existing relationship
18977       description: delete an existing relationship
18978       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18979       consumes:
18980         - application/json
18981         - application/xml
18982       produces:
18983         - application/json
18984         - application/xml
18985       responses:
18986         "default":
18987           description: Response codes found in [response codes](https://wiki.onap.org/).
18988       parameters:
18989         - name: owning-entity-id
18990           in: path
18991           description: UUID of an owning entity
18992           required: true
18993           type: string
18994           example: __OWNING-ENTITY-ID__
18995   /business/owning-entities/owning-entity/{owning-entity-id}:
18996     get:
18997       tags:
18998         - Business
18999       summary: returns owning-entity
19000       description: returns owning-entity
19001       operationId: getBusinessOwningEntitiesOwningEntity
19002       produces:
19003         - application/json
19004         - application/xml
19005       responses:
19006         "200":
19007           description: successful operation
19008           schema:
19009               $ref: "#/getDefinitions/owning-entity"
19010         "default":
19011           description: Response codes found in [response codes](https://wiki.onap.org/).
19012       parameters:
19013         - name: owning-entity-id
19014           in: path
19015           description: UUID of an owning entity
19016           required: true
19017           type: string
19018           example: __OWNING-ENTITY-ID__
19019     put:
19020       tags:
19021         - Business
19022       summary: create or update an existing owning-entity
19023       description: |
19024         Create or update an existing owning-entity.
19025         #
19026         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
19027       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
19028       consumes:
19029         - application/json
19030         - application/xml
19031       produces:
19032         - application/json
19033         - application/xml
19034       responses:
19035         "default":
19036           description: Response codes found in [response codes](https://wiki.onap.org/).
19037       parameters:
19038         - name: owning-entity-id
19039           in: path
19040           description: UUID of an owning entity
19041           required: true
19042           type: string
19043           example: __OWNING-ENTITY-ID__
19044         - name: body
19045           in: body
19046           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
19047           required: true
19048           schema:
19049             $ref: "#/definitions/owning-entity"
19050     patch:
19051       tags:
19052         - Business
19053       summary: update an existing owning-entity
19054       description: |
19055         Update an existing owning-entity
19056         #
19057         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19058         The PUT operation will entirely replace an existing object.
19059         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.
19060         #
19061         Other differences between PUT and PATCH are:
19062         #
19063         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19064         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19065         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19066       operationId: UpdateBusinessOwningEntitiesOwningEntity
19067       consumes:
19068         - application/json
19069         - application/xml
19070       produces:
19071         - application/json
19072         - application/xml
19073       responses:
19074         "default":
19075           description: Response codes found in [response codes](https://wiki.onap.org/).
19076       parameters:
19077         - name: owning-entity-id
19078           in: path
19079           description: UUID of an owning entity
19080           required: true
19081           type: string
19082           example: __OWNING-ENTITY-ID__
19083         - name: body
19084           in: body
19085           description: owning-entity object that needs to be created or updated.
19086           required: true
19087           schema:
19088             $ref: "#/patchDefinitions/owning-entity"
19089     delete:
19090       tags:
19091         - Business
19092       summary: delete an existing owning-entity
19093       description: delete an existing owning-entity
19094       operationId: deleteBusinessOwningEntitiesOwningEntity
19095       consumes:
19096         - application/json
19097         - application/xml
19098       produces:
19099         - application/json
19100         - application/xml
19101       responses:
19102         "default":
19103           description: Response codes found in [response codes](https://wiki.onap.org/).
19104       parameters:
19105         - name: owning-entity-id
19106           in: path
19107           description: UUID of an owning entity
19108           required: true
19109           type: string
19110           example: __OWNING-ENTITY-ID__
19111         - name: resource-version
19112           in: query
19113           description: resource-version for concurrency
19114           required: true
19115           type: string
19116   /business/owning-entities:
19117     get:
19118       tags:
19119         - Business
19120       summary: returns owning-entities
19121       description: returns owning-entities
19122       operationId: getBusinessOwningEntities
19123       produces:
19124         - application/json
19125         - application/xml
19126       responses:
19127         "200":
19128           description: successful operation
19129           schema:
19130               $ref: "#/getDefinitions/owning-entities"
19131         "default":
19132           description: Response codes found in [response codes](https://wiki.onap.org/).
19133   /business/platforms/platform/{platform-name}/relationship-list/relationship:
19134     put:
19135       tags:
19136         - Business
19137       summary: see node definition for valid relationships
19138       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
19139       consumes:
19140         - application/json
19141         - application/xml
19142       produces:
19143         - application/json
19144         - application/xml
19145       responses:
19146         "default":
19147           description: Response codes found in [response codes](https://wiki.onap.org/).
19148       parameters:
19149         - name: platform-name
19150           in: path
19151           description: Name of the platform
19152           required: true
19153           type: string
19154           example: __PLATFORM-NAME__
19155         - name: body
19156           in: body
19157           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
19158           required: true
19159           schema:
19160             $ref: "#/definitions/relationship"
19161     delete:
19162       tags:
19163         - Business
19164       summary: delete an existing relationship
19165       description: delete an existing relationship
19166       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
19167       consumes:
19168         - application/json
19169         - application/xml
19170       produces:
19171         - application/json
19172         - application/xml
19173       responses:
19174         "default":
19175           description: Response codes found in [response codes](https://wiki.onap.org/).
19176       parameters:
19177         - name: platform-name
19178           in: path
19179           description: Name of the platform
19180           required: true
19181           type: string
19182           example: __PLATFORM-NAME__
19183   /business/platforms/platform/{platform-name}:
19184     get:
19185       tags:
19186         - Business
19187       summary: returns platform
19188       description: returns platform
19189       operationId: getBusinessPlatformsPlatform
19190       produces:
19191         - application/json
19192         - application/xml
19193       responses:
19194         "200":
19195           description: successful operation
19196           schema:
19197               $ref: "#/getDefinitions/platform"
19198         "default":
19199           description: Response codes found in [response codes](https://wiki.onap.org/).
19200       parameters:
19201         - name: platform-name
19202           in: path
19203           description: Name of the platform
19204           required: true
19205           type: string
19206           example: __PLATFORM-NAME__
19207     put:
19208       tags:
19209         - Business
19210       summary: create or update an existing platform
19211       description: |
19212         Create or update an existing platform.
19213         #
19214         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
19215       operationId: createOrUpdateBusinessPlatformsPlatform
19216       consumes:
19217         - application/json
19218         - application/xml
19219       produces:
19220         - application/json
19221         - application/xml
19222       responses:
19223         "default":
19224           description: Response codes found in [response codes](https://wiki.onap.org/).
19225       parameters:
19226         - name: platform-name
19227           in: path
19228           description: Name of the platform
19229           required: true
19230           type: string
19231           example: __PLATFORM-NAME__
19232         - name: body
19233           in: body
19234           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
19235           required: true
19236           schema:
19237             $ref: "#/definitions/platform"
19238     patch:
19239       tags:
19240         - Business
19241       summary: update an existing platform
19242       description: |
19243         Update an existing platform
19244         #
19245         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19246         The PUT operation will entirely replace an existing object.
19247         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.
19248         #
19249         Other differences between PUT and PATCH are:
19250         #
19251         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19252         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19253         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19254       operationId: UpdateBusinessPlatformsPlatform
19255       consumes:
19256         - application/json
19257         - application/xml
19258       produces:
19259         - application/json
19260         - application/xml
19261       responses:
19262         "default":
19263           description: Response codes found in [response codes](https://wiki.onap.org/).
19264       parameters:
19265         - name: platform-name
19266           in: path
19267           description: Name of the platform
19268           required: true
19269           type: string
19270           example: __PLATFORM-NAME__
19271         - name: body
19272           in: body
19273           description: platform object that needs to be created or updated.
19274           required: true
19275           schema:
19276             $ref: "#/patchDefinitions/platform"
19277     delete:
19278       tags:
19279         - Business
19280       summary: delete an existing platform
19281       description: delete an existing platform
19282       operationId: deleteBusinessPlatformsPlatform
19283       consumes:
19284         - application/json
19285         - application/xml
19286       produces:
19287         - application/json
19288         - application/xml
19289       responses:
19290         "default":
19291           description: Response codes found in [response codes](https://wiki.onap.org/).
19292       parameters:
19293         - name: platform-name
19294           in: path
19295           description: Name of the platform
19296           required: true
19297           type: string
19298           example: __PLATFORM-NAME__
19299         - name: resource-version
19300           in: query
19301           description: resource-version for concurrency
19302           required: true
19303           type: string
19304   /business/platforms:
19305     get:
19306       tags:
19307         - Business
19308       summary: returns platforms
19309       description: returns platforms
19310       operationId: getBusinessPlatforms
19311       produces:
19312         - application/json
19313         - application/xml
19314       responses:
19315         "200":
19316           description: successful operation
19317           schema:
19318               $ref: "#/getDefinitions/platforms"
19319         "default":
19320           description: Response codes found in [response codes](https://wiki.onap.org/).
19321   /business/projects/project/{project-name}/relationship-list/relationship:
19322     put:
19323       tags:
19324         - Business
19325       summary: see node definition for valid relationships
19326       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
19327       consumes:
19328         - application/json
19329         - application/xml
19330       produces:
19331         - application/json
19332         - application/xml
19333       responses:
19334         "default":
19335           description: Response codes found in [response codes](https://wiki.onap.org/).
19336       parameters:
19337         - name: project-name
19338           in: path
19339           description: Name of the project deploying a service
19340           required: true
19341           type: string
19342           example: __PROJECT-NAME__
19343         - name: body
19344           in: body
19345           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
19346           required: true
19347           schema:
19348             $ref: "#/definitions/relationship"
19349     delete:
19350       tags:
19351         - Business
19352       summary: delete an existing relationship
19353       description: delete an existing relationship
19354       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
19355       consumes:
19356         - application/json
19357         - application/xml
19358       produces:
19359         - application/json
19360         - application/xml
19361       responses:
19362         "default":
19363           description: Response codes found in [response codes](https://wiki.onap.org/).
19364       parameters:
19365         - name: project-name
19366           in: path
19367           description: Name of the project deploying a service
19368           required: true
19369           type: string
19370           example: __PROJECT-NAME__
19371   /business/projects/project/{project-name}:
19372     get:
19373       tags:
19374         - Business
19375       summary: returns project
19376       description: returns project
19377       operationId: getBusinessProjectsProject
19378       produces:
19379         - application/json
19380         - application/xml
19381       responses:
19382         "200":
19383           description: successful operation
19384           schema:
19385               $ref: "#/getDefinitions/project"
19386         "default":
19387           description: Response codes found in [response codes](https://wiki.onap.org/).
19388       parameters:
19389         - name: project-name
19390           in: path
19391           description: Name of the project deploying a service
19392           required: true
19393           type: string
19394           example: __PROJECT-NAME__
19395     put:
19396       tags:
19397         - Business
19398       summary: create or update an existing project
19399       description: |
19400         Create or update an existing project.
19401         #
19402         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
19403       operationId: createOrUpdateBusinessProjectsProject
19404       consumes:
19405         - application/json
19406         - application/xml
19407       produces:
19408         - application/json
19409         - application/xml
19410       responses:
19411         "default":
19412           description: Response codes found in [response codes](https://wiki.onap.org/).
19413       parameters:
19414         - name: project-name
19415           in: path
19416           description: Name of the project deploying a service
19417           required: true
19418           type: string
19419           example: __PROJECT-NAME__
19420         - name: body
19421           in: body
19422           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
19423           required: true
19424           schema:
19425             $ref: "#/definitions/project"
19426     patch:
19427       tags:
19428         - Business
19429       summary: update an existing project
19430       description: |
19431         Update an existing project
19432         #
19433         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19434         The PUT operation will entirely replace an existing object.
19435         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.
19436         #
19437         Other differences between PUT and PATCH are:
19438         #
19439         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19440         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19441         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19442       operationId: UpdateBusinessProjectsProject
19443       consumes:
19444         - application/json
19445         - application/xml
19446       produces:
19447         - application/json
19448         - application/xml
19449       responses:
19450         "default":
19451           description: Response codes found in [response codes](https://wiki.onap.org/).
19452       parameters:
19453         - name: project-name
19454           in: path
19455           description: Name of the project deploying a service
19456           required: true
19457           type: string
19458           example: __PROJECT-NAME__
19459         - name: body
19460           in: body
19461           description: project object that needs to be created or updated.
19462           required: true
19463           schema:
19464             $ref: "#/patchDefinitions/project"
19465     delete:
19466       tags:
19467         - Business
19468       summary: delete an existing project
19469       description: delete an existing project
19470       operationId: deleteBusinessProjectsProject
19471       consumes:
19472         - application/json
19473         - application/xml
19474       produces:
19475         - application/json
19476         - application/xml
19477       responses:
19478         "default":
19479           description: Response codes found in [response codes](https://wiki.onap.org/).
19480       parameters:
19481         - name: project-name
19482           in: path
19483           description: Name of the project deploying a service
19484           required: true
19485           type: string
19486           example: __PROJECT-NAME__
19487         - name: resource-version
19488           in: query
19489           description: resource-version for concurrency
19490           required: true
19491           type: string
19492   /business/projects:
19493     get:
19494       tags:
19495         - Business
19496       summary: returns projects
19497       description: returns projects
19498       operationId: getBusinessProjects
19499       produces:
19500         - application/json
19501         - application/xml
19502       responses:
19503         "200":
19504           description: successful operation
19505           schema:
19506               $ref: "#/getDefinitions/projects"
19507         "default":
19508           description: Response codes found in [response codes](https://wiki.onap.org/).
19509   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
19510     put:
19511       tags:
19512         - ServiceDesignAndCreation
19513       summary: see node definition for valid relationships
19514       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
19515       consumes:
19516         - application/json
19517         - application/xml
19518       produces:
19519         - application/json
19520         - application/xml
19521       responses:
19522         "default":
19523           description: Response codes found in [response codes](https://wiki.onap.org/).
19524       parameters:
19525         - name: vnf-image-uuid
19526           in: path
19527           description: Unique ID of this asset
19528           required: true
19529           type: string
19530           example: __VNF-IMAGE-UUID__
19531         - name: body
19532           in: body
19533           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
19534           required: true
19535           schema:
19536             $ref: "#/definitions/relationship"
19537     delete:
19538       tags:
19539         - ServiceDesignAndCreation
19540       summary: delete an existing relationship
19541       description: delete an existing relationship
19542       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
19543       consumes:
19544         - application/json
19545         - application/xml
19546       produces:
19547         - application/json
19548         - application/xml
19549       responses:
19550         "default":
19551           description: Response codes found in [response codes](https://wiki.onap.org/).
19552       parameters:
19553         - name: vnf-image-uuid
19554           in: path
19555           description: Unique ID of this asset
19556           required: true
19557           type: string
19558           example: __VNF-IMAGE-UUID__
19559   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
19560     get:
19561       tags:
19562         - ServiceDesignAndCreation
19563       summary: returns vnf-image
19564       description: returns vnf-image
19565       operationId: getServiceDesignAndCreationVnfImagesVnfImage
19566       produces:
19567         - application/json
19568         - application/xml
19569       responses:
19570         "200":
19571           description: successful operation
19572           schema:
19573               $ref: "#/getDefinitions/vnf-image"
19574         "default":
19575           description: Response codes found in [response codes](https://wiki.onap.org/).
19576       parameters:
19577         - name: vnf-image-uuid
19578           in: path
19579           description: Unique ID of this asset
19580           required: true
19581           type: string
19582           example: __VNF-IMAGE-UUID__
19583         - name: application
19584           in: query
19585           description: The application that the image instantiates.
19586           required: false
19587           type: string
19588         - name: application-vendor
19589           in: query
19590           description: The vendor of the application.
19591           required: false
19592           type: string
19593         - name: application-version
19594           in: query
19595           description: The version of the application.
19596           required: false
19597           type: string
19598     put:
19599       tags:
19600         - ServiceDesignAndCreation
19601       summary: create or update an existing vnf-image
19602       description: |
19603         Create or update an existing vnf-image.
19604         #
19605         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
19606       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
19607       consumes:
19608         - application/json
19609         - application/xml
19610       produces:
19611         - application/json
19612         - application/xml
19613       responses:
19614         "default":
19615           description: Response codes found in [response codes](https://wiki.onap.org/).
19616       parameters:
19617         - name: vnf-image-uuid
19618           in: path
19619           description: Unique ID of this asset
19620           required: true
19621           type: string
19622           example: __VNF-IMAGE-UUID__
19623         - name: body
19624           in: body
19625           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
19626           required: true
19627           schema:
19628             $ref: "#/definitions/vnf-image"
19629     patch:
19630       tags:
19631         - ServiceDesignAndCreation
19632       summary: update an existing vnf-image
19633       description: |
19634         Update an existing vnf-image
19635         #
19636         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19637         The PUT operation will entirely replace an existing object.
19638         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.
19639         #
19640         Other differences between PUT and PATCH are:
19641         #
19642         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19643         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19644         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19645       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
19646       consumes:
19647         - application/json
19648         - application/xml
19649       produces:
19650         - application/json
19651         - application/xml
19652       responses:
19653         "default":
19654           description: Response codes found in [response codes](https://wiki.onap.org/).
19655       parameters:
19656         - name: vnf-image-uuid
19657           in: path
19658           description: Unique ID of this asset
19659           required: true
19660           type: string
19661           example: __VNF-IMAGE-UUID__
19662         - name: body
19663           in: body
19664           description: vnf-image object that needs to be created or updated.
19665           required: true
19666           schema:
19667             $ref: "#/patchDefinitions/vnf-image"
19668     delete:
19669       tags:
19670         - ServiceDesignAndCreation
19671       summary: delete an existing vnf-image
19672       description: delete an existing vnf-image
19673       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
19674       consumes:
19675         - application/json
19676         - application/xml
19677       produces:
19678         - application/json
19679         - application/xml
19680       responses:
19681         "default":
19682           description: Response codes found in [response codes](https://wiki.onap.org/).
19683       parameters:
19684         - name: vnf-image-uuid
19685           in: path
19686           description: Unique ID of this asset
19687           required: true
19688           type: string
19689           example: __VNF-IMAGE-UUID__
19690         - name: resource-version
19691           in: query
19692           description: resource-version for concurrency
19693           required: true
19694           type: string
19695   /service-design-and-creation/vnf-images:
19696     get:
19697       tags:
19698         - ServiceDesignAndCreation
19699       summary: returns vnf-images
19700       description: returns vnf-images
19701       operationId: getServiceDesignAndCreationVnfImages
19702       produces:
19703         - application/json
19704         - application/xml
19705       responses:
19706         "200":
19707           description: successful operation
19708           schema:
19709               $ref: "#/getDefinitions/vnf-images"
19710         "default":
19711           description: Response codes found in [response codes](https://wiki.onap.org/).
19712   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
19713     put:
19714       tags:
19715         - ServiceDesignAndCreation
19716       summary: see node definition for valid relationships
19717       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
19718       consumes:
19719         - application/json
19720         - application/xml
19721       produces:
19722         - application/json
19723         - application/xml
19724       responses:
19725         "default":
19726           description: Response codes found in [response codes](https://wiki.onap.org/).
19727       parameters:
19728         - name: service-id
19729           in: path
19730           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19731           required: true
19732           type: string
19733           example: __SERVICE-ID__
19734         - name: body
19735           in: body
19736           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
19737           required: true
19738           schema:
19739             $ref: "#/definitions/relationship"
19740     delete:
19741       tags:
19742         - ServiceDesignAndCreation
19743       summary: delete an existing relationship
19744       description: delete an existing relationship
19745       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
19746       consumes:
19747         - application/json
19748         - application/xml
19749       produces:
19750         - application/json
19751         - application/xml
19752       responses:
19753         "default":
19754           description: Response codes found in [response codes](https://wiki.onap.org/).
19755       parameters:
19756         - name: service-id
19757           in: path
19758           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19759           required: true
19760           type: string
19761           example: __SERVICE-ID__
19762   /service-design-and-creation/services/service/{service-id}:
19763     get:
19764       tags:
19765         - ServiceDesignAndCreation
19766       summary: returns service
19767       description: returns service
19768       operationId: getServiceDesignAndCreationServicesService
19769       produces:
19770         - application/json
19771         - application/xml
19772       responses:
19773         "200":
19774           description: successful operation
19775           schema:
19776               $ref: "#/getDefinitions/service"
19777         "default":
19778           description: Response codes found in [response codes](https://wiki.onap.org/).
19779       parameters:
19780         - name: service-id
19781           in: path
19782           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19783           required: true
19784           type: string
19785           example: __SERVICE-ID__
19786         - name: service-description
19787           in: query
19788           description: Description of the service
19789           required: false
19790           type: string
19791     put:
19792       tags:
19793         - ServiceDesignAndCreation
19794       summary: create or update an existing service
19795       description: |
19796         Create or update an existing service.
19797         #
19798         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
19799       operationId: createOrUpdateServiceDesignAndCreationServicesService
19800       consumes:
19801         - application/json
19802         - application/xml
19803       produces:
19804         - application/json
19805         - application/xml
19806       responses:
19807         "default":
19808           description: Response codes found in [response codes](https://wiki.onap.org/).
19809       parameters:
19810         - name: service-id
19811           in: path
19812           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19813           required: true
19814           type: string
19815           example: __SERVICE-ID__
19816         - name: body
19817           in: body
19818           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
19819           required: true
19820           schema:
19821             $ref: "#/definitions/service"
19822     patch:
19823       tags:
19824         - ServiceDesignAndCreation
19825       summary: update an existing service
19826       description: |
19827         Update an existing service
19828         #
19829         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19830         The PUT operation will entirely replace an existing object.
19831         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.
19832         #
19833         Other differences between PUT and PATCH are:
19834         #
19835         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19836         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19837         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19838       operationId: UpdateServiceDesignAndCreationServicesService
19839       consumes:
19840         - application/json
19841         - application/xml
19842       produces:
19843         - application/json
19844         - application/xml
19845       responses:
19846         "default":
19847           description: Response codes found in [response codes](https://wiki.onap.org/).
19848       parameters:
19849         - name: service-id
19850           in: path
19851           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19852           required: true
19853           type: string
19854           example: __SERVICE-ID__
19855         - name: body
19856           in: body
19857           description: service object that needs to be created or updated.
19858           required: true
19859           schema:
19860             $ref: "#/patchDefinitions/service"
19861     delete:
19862       tags:
19863         - ServiceDesignAndCreation
19864       summary: delete an existing service
19865       description: delete an existing service
19866       operationId: deleteServiceDesignAndCreationServicesService
19867       consumes:
19868         - application/json
19869         - application/xml
19870       produces:
19871         - application/json
19872         - application/xml
19873       responses:
19874         "default":
19875           description: Response codes found in [response codes](https://wiki.onap.org/).
19876       parameters:
19877         - name: service-id
19878           in: path
19879           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19880           required: true
19881           type: string
19882           example: __SERVICE-ID__
19883         - name: resource-version
19884           in: query
19885           description: resource-version for concurrency
19886           required: true
19887           type: string
19888   /service-design-and-creation/services:
19889     get:
19890       tags:
19891         - ServiceDesignAndCreation
19892       summary: returns services
19893       description: returns services
19894       operationId: getServiceDesignAndCreationServices
19895       produces:
19896         - application/json
19897         - application/xml
19898       responses:
19899         "200":
19900           description: successful operation
19901           schema:
19902               $ref: "#/getDefinitions/services"
19903         "default":
19904           description: Response codes found in [response codes](https://wiki.onap.org/).
19905   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
19906     put:
19907       tags:
19908         - ServiceDesignAndCreation
19909       summary: see node definition for valid relationships
19910       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19911       consumes:
19912         - application/json
19913         - application/xml
19914       produces:
19915         - application/json
19916         - application/xml
19917       responses:
19918         "default":
19919           description: Response codes found in [response codes](https://wiki.onap.org/).
19920       parameters:
19921         - name: service-type
19922           in: path
19923           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19924           required: true
19925           type: string
19926           example: __SERVICE-TYPE__
19927         - name: vnf-type
19928           in: path
19929           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.
19930           required: true
19931           type: string
19932           example: __VNF-TYPE__
19933         - name: body
19934           in: body
19935           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
19936           required: true
19937           schema:
19938             $ref: "#/definitions/relationship"
19939     delete:
19940       tags:
19941         - ServiceDesignAndCreation
19942       summary: delete an existing relationship
19943       description: delete an existing relationship
19944       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19945       consumes:
19946         - application/json
19947         - application/xml
19948       produces:
19949         - application/json
19950         - application/xml
19951       responses:
19952         "default":
19953           description: Response codes found in [response codes](https://wiki.onap.org/).
19954       parameters:
19955         - name: service-type
19956           in: path
19957           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19958           required: true
19959           type: string
19960           example: __SERVICE-TYPE__
19961         - name: vnf-type
19962           in: path
19963           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.
19964           required: true
19965           type: string
19966           example: __VNF-TYPE__
19967   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
19968     get:
19969       tags:
19970         - ServiceDesignAndCreation
19971       summary: returns service-capability
19972       description: returns service-capability
19973       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
19974       produces:
19975         - application/json
19976         - application/xml
19977       responses:
19978         "200":
19979           description: successful operation
19980           schema:
19981               $ref: "#/getDefinitions/service-capability"
19982         "default":
19983           description: Response codes found in [response codes](https://wiki.onap.org/).
19984       parameters:
19985         - name: service-type
19986           in: path
19987           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19988           required: true
19989           type: string
19990           example: __SERVICE-TYPE__
19991         - name: vnf-type
19992           in: path
19993           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.
19994           required: true
19995           type: string
19996           example: __VNF-TYPE__
19997     put:
19998       tags:
19999         - ServiceDesignAndCreation
20000       summary: create or update an existing service-capability
20001       description: |
20002         Create or update an existing service-capability.
20003         #
20004         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
20005       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
20006       consumes:
20007         - application/json
20008         - application/xml
20009       produces:
20010         - application/json
20011         - application/xml
20012       responses:
20013         "default":
20014           description: Response codes found in [response codes](https://wiki.onap.org/).
20015       parameters:
20016         - name: service-type
20017           in: path
20018           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20019           required: true
20020           type: string
20021           example: __SERVICE-TYPE__
20022         - name: vnf-type
20023           in: path
20024           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.
20025           required: true
20026           type: string
20027           example: __VNF-TYPE__
20028         - name: body
20029           in: body
20030           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
20031           required: true
20032           schema:
20033             $ref: "#/definitions/service-capability"
20034     patch:
20035       tags:
20036         - ServiceDesignAndCreation
20037       summary: update an existing service-capability
20038       description: |
20039         Update an existing service-capability
20040         #
20041         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20042         The PUT operation will entirely replace an existing object.
20043         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.
20044         #
20045         Other differences between PUT and PATCH are:
20046         #
20047         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20048         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20049         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20050       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
20051       consumes:
20052         - application/json
20053         - application/xml
20054       produces:
20055         - application/json
20056         - application/xml
20057       responses:
20058         "default":
20059           description: Response codes found in [response codes](https://wiki.onap.org/).
20060       parameters:
20061         - name: service-type
20062           in: path
20063           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20064           required: true
20065           type: string
20066           example: __SERVICE-TYPE__
20067         - name: vnf-type
20068           in: path
20069           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.
20070           required: true
20071           type: string
20072           example: __VNF-TYPE__
20073         - name: body
20074           in: body
20075           description: service-capability object that needs to be created or updated.
20076           required: true
20077           schema:
20078             $ref: "#/patchDefinitions/service-capability"
20079     delete:
20080       tags:
20081         - ServiceDesignAndCreation
20082       summary: delete an existing service-capability
20083       description: delete an existing service-capability
20084       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
20085       consumes:
20086         - application/json
20087         - application/xml
20088       produces:
20089         - application/json
20090         - application/xml
20091       responses:
20092         "default":
20093           description: Response codes found in [response codes](https://wiki.onap.org/).
20094       parameters:
20095         - name: service-type
20096           in: path
20097           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
20098           required: true
20099           type: string
20100           example: __SERVICE-TYPE__
20101         - name: vnf-type
20102           in: path
20103           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.
20104           required: true
20105           type: string
20106           example: __VNF-TYPE__
20107         - name: resource-version
20108           in: query
20109           description: resource-version for concurrency
20110           required: true
20111           type: string
20112   /service-design-and-creation/service-capabilities:
20113     get:
20114       tags:
20115         - ServiceDesignAndCreation
20116       summary: returns service-capabilities
20117       description: returns service-capabilities
20118       operationId: getServiceDesignAndCreationServiceCapabilities
20119       produces:
20120         - application/json
20121         - application/xml
20122       responses:
20123         "200":
20124           description: successful operation
20125           schema:
20126               $ref: "#/getDefinitions/service-capabilities"
20127         "default":
20128           description: Response codes found in [response codes](https://wiki.onap.org/).
20129   /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:
20130     put:
20131       tags:
20132         - ServiceDesignAndCreation
20133       summary: see node definition for valid relationships
20134       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
20135       consumes:
20136         - application/json
20137         - application/xml
20138       produces:
20139         - application/json
20140         - application/xml
20141       responses:
20142         "default":
20143           description: Response codes found in [response codes](https://wiki.onap.org/).
20144       parameters:
20145         - name: model-invariant-id
20146           in: path
20147           description: Unique identifier corresponding to the main definition of a model in ASDC
20148           required: true
20149           type: string
20150           example: __MODEL-INVARIANT-ID__
20151         - name: model-version-id
20152           in: path
20153           description: Unique identifier corresponding to one version of a model in ASDC
20154           required: true
20155           type: string
20156           example: __MODEL-VERSION-ID__
20157         - name: model-element-uuid
20158           in: path
20159           required: true
20160           type: string
20161           example: __MODEL-ELEMENT-UUID__
20162         - name: model-constraint-uuid
20163           in: path
20164           required: true
20165           type: string
20166           example: __MODEL-CONSTRAINT-UUID__
20167         - name: constrained-element-set-uuid
20168           in: path
20169           required: true
20170           type: string
20171           example: __CONSTRAINED-ELEMENT-SET-UUID__
20172         - name: element-choice-set-uuid
20173           in: path
20174           required: true
20175           type: string
20176           example: __ELEMENT-CHOICE-SET-UUID__
20177         - name: body
20178           in: body
20179           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
20180           required: true
20181           schema:
20182             $ref: "#/definitions/relationship"
20183     delete:
20184       tags:
20185         - ServiceDesignAndCreation
20186       summary: delete an existing relationship
20187       description: delete an existing relationship
20188       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
20189       consumes:
20190         - application/json
20191         - application/xml
20192       produces:
20193         - application/json
20194         - application/xml
20195       responses:
20196         "default":
20197           description: Response codes found in [response codes](https://wiki.onap.org/).
20198       parameters:
20199         - name: model-invariant-id
20200           in: path
20201           description: Unique identifier corresponding to the main definition of a model in ASDC
20202           required: true
20203           type: string
20204           example: __MODEL-INVARIANT-ID__
20205         - name: model-version-id
20206           in: path
20207           description: Unique identifier corresponding to one version of a model in ASDC
20208           required: true
20209           type: string
20210           example: __MODEL-VERSION-ID__
20211         - name: model-element-uuid
20212           in: path
20213           required: true
20214           type: string
20215           example: __MODEL-ELEMENT-UUID__
20216         - name: model-constraint-uuid
20217           in: path
20218           required: true
20219           type: string
20220           example: __MODEL-CONSTRAINT-UUID__
20221         - name: constrained-element-set-uuid
20222           in: path
20223           required: true
20224           type: string
20225           example: __CONSTRAINED-ELEMENT-SET-UUID__
20226         - name: element-choice-set-uuid
20227           in: path
20228           required: true
20229           type: string
20230           example: __ELEMENT-CHOICE-SET-UUID__
20231   /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}:
20232     get:
20233       tags:
20234         - ServiceDesignAndCreation
20235       summary: returns element-choice-set
20236       description: returns element-choice-set
20237       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20238       produces:
20239         - application/json
20240         - application/xml
20241       responses:
20242         "200":
20243           description: successful operation
20244           schema:
20245               $ref: "#/getDefinitions/element-choice-set"
20246         "default":
20247           description: Response codes found in [response codes](https://wiki.onap.org/).
20248       parameters:
20249         - name: model-invariant-id
20250           in: path
20251           description: Unique identifier corresponding to the main definition of a model in ASDC
20252           required: true
20253           type: string
20254           example: __MODEL-INVARIANT-ID__
20255         - name: model-version-id
20256           in: path
20257           description: Unique identifier corresponding to one version of a model in ASDC
20258           required: true
20259           type: string
20260           example: __MODEL-VERSION-ID__
20261         - name: model-element-uuid
20262           in: path
20263           required: true
20264           type: string
20265           example: __MODEL-ELEMENT-UUID__
20266         - name: model-constraint-uuid
20267           in: path
20268           required: true
20269           type: string
20270           example: __MODEL-CONSTRAINT-UUID__
20271         - name: constrained-element-set-uuid
20272           in: path
20273           required: true
20274           type: string
20275           example: __CONSTRAINED-ELEMENT-SET-UUID__
20276         - name: element-choice-set-uuid
20277           in: path
20278           required: true
20279           type: string
20280           example: __ELEMENT-CHOICE-SET-UUID__
20281         - name: model-type
20282           in: query
20283           description: Type of the model, e.g., service, resource, widget, etc.
20284           required: false
20285           type: string
20286         - name: model-name
20287           in: query
20288           description: Name of the model, which can change from version to version.
20289           required: false
20290           type: string
20291         - name: model-version
20292           in: query
20293           description: Version
20294           required: false
20295           type: string
20296         - name: distribution-status
20297           in: query
20298           description: Distribution Status
20299           required: false
20300           type: string
20301     put:
20302       tags:
20303         - ServiceDesignAndCreation
20304       summary: create or update an existing element-choice-set
20305       description: |
20306         Create or update an existing element-choice-set.
20307         #
20308         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
20309       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20310       consumes:
20311         - application/json
20312         - application/xml
20313       produces:
20314         - application/json
20315         - application/xml
20316       responses:
20317         "default":
20318           description: Response codes found in [response codes](https://wiki.onap.org/).
20319       parameters:
20320         - name: model-invariant-id
20321           in: path
20322           description: Unique identifier corresponding to the main definition of a model in ASDC
20323           required: true
20324           type: string
20325           example: __MODEL-INVARIANT-ID__
20326         - name: model-version-id
20327           in: path
20328           description: Unique identifier corresponding to one version of a model in ASDC
20329           required: true
20330           type: string
20331           example: __MODEL-VERSION-ID__
20332         - name: model-element-uuid
20333           in: path
20334           required: true
20335           type: string
20336           example: __MODEL-ELEMENT-UUID__
20337         - name: model-constraint-uuid
20338           in: path
20339           required: true
20340           type: string
20341           example: __MODEL-CONSTRAINT-UUID__
20342         - name: constrained-element-set-uuid
20343           in: path
20344           required: true
20345           type: string
20346           example: __CONSTRAINED-ELEMENT-SET-UUID__
20347         - name: element-choice-set-uuid
20348           in: path
20349           required: true
20350           type: string
20351           example: __ELEMENT-CHOICE-SET-UUID__
20352         - name: body
20353           in: body
20354           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
20355           required: true
20356           schema:
20357             $ref: "#/definitions/element-choice-set"
20358     patch:
20359       tags:
20360         - ServiceDesignAndCreation
20361       summary: update an existing element-choice-set
20362       description: |
20363         Update an existing element-choice-set
20364         #
20365         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20366         The PUT operation will entirely replace an existing object.
20367         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.
20368         #
20369         Other differences between PUT and PATCH are:
20370         #
20371         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20372         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20373         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20374       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20375       consumes:
20376         - application/json
20377         - application/xml
20378       produces:
20379         - application/json
20380         - application/xml
20381       responses:
20382         "default":
20383           description: Response codes found in [response codes](https://wiki.onap.org/).
20384       parameters:
20385         - name: model-invariant-id
20386           in: path
20387           description: Unique identifier corresponding to the main definition of a model in ASDC
20388           required: true
20389           type: string
20390           example: __MODEL-INVARIANT-ID__
20391         - name: model-version-id
20392           in: path
20393           description: Unique identifier corresponding to one version of a model in ASDC
20394           required: true
20395           type: string
20396           example: __MODEL-VERSION-ID__
20397         - name: model-element-uuid
20398           in: path
20399           required: true
20400           type: string
20401           example: __MODEL-ELEMENT-UUID__
20402         - name: model-constraint-uuid
20403           in: path
20404           required: true
20405           type: string
20406           example: __MODEL-CONSTRAINT-UUID__
20407         - name: constrained-element-set-uuid
20408           in: path
20409           required: true
20410           type: string
20411           example: __CONSTRAINED-ELEMENT-SET-UUID__
20412         - name: element-choice-set-uuid
20413           in: path
20414           required: true
20415           type: string
20416           example: __ELEMENT-CHOICE-SET-UUID__
20417         - name: body
20418           in: body
20419           description: element-choice-set object that needs to be created or updated.
20420           required: true
20421           schema:
20422             $ref: "#/patchDefinitions/element-choice-set"
20423     delete:
20424       tags:
20425         - ServiceDesignAndCreation
20426       summary: delete an existing element-choice-set
20427       description: delete an existing element-choice-set
20428       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
20429       consumes:
20430         - application/json
20431         - application/xml
20432       produces:
20433         - application/json
20434         - application/xml
20435       responses:
20436         "default":
20437           description: Response codes found in [response codes](https://wiki.onap.org/).
20438       parameters:
20439         - name: model-invariant-id
20440           in: path
20441           description: Unique identifier corresponding to the main definition of a model in ASDC
20442           required: true
20443           type: string
20444           example: __MODEL-INVARIANT-ID__
20445         - name: model-version-id
20446           in: path
20447           description: Unique identifier corresponding to one version of a model in ASDC
20448           required: true
20449           type: string
20450           example: __MODEL-VERSION-ID__
20451         - name: model-element-uuid
20452           in: path
20453           required: true
20454           type: string
20455           example: __MODEL-ELEMENT-UUID__
20456         - name: model-constraint-uuid
20457           in: path
20458           required: true
20459           type: string
20460           example: __MODEL-CONSTRAINT-UUID__
20461         - name: constrained-element-set-uuid
20462           in: path
20463           required: true
20464           type: string
20465           example: __CONSTRAINED-ELEMENT-SET-UUID__
20466         - name: element-choice-set-uuid
20467           in: path
20468           required: true
20469           type: string
20470           example: __ELEMENT-CHOICE-SET-UUID__
20471         - name: resource-version
20472           in: query
20473           description: resource-version for concurrency
20474           required: true
20475           type: string
20476   /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:
20477     get:
20478       tags:
20479         - ServiceDesignAndCreation
20480       summary: returns element-choice-sets
20481       description: returns element-choice-sets
20482       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
20483       produces:
20484         - application/json
20485         - application/xml
20486       responses:
20487         "200":
20488           description: successful operation
20489           schema:
20490               $ref: "#/getDefinitions/element-choice-sets"
20491         "default":
20492           description: Response codes found in [response codes](https://wiki.onap.org/).
20493       parameters:
20494         - name: model-invariant-id
20495           in: path
20496           description: Unique identifier corresponding to the main definition of a model in ASDC
20497           required: true
20498           type: string
20499           example: __MODEL-INVARIANT-ID__
20500         - name: model-version-id
20501           in: path
20502           description: Unique identifier corresponding to one version of a model in ASDC
20503           required: true
20504           type: string
20505           example: __MODEL-VERSION-ID__
20506         - name: model-element-uuid
20507           in: path
20508           required: true
20509           type: string
20510           example: __MODEL-ELEMENT-UUID__
20511         - name: model-constraint-uuid
20512           in: path
20513           required: true
20514           type: string
20515           example: __MODEL-CONSTRAINT-UUID__
20516         - name: constrained-element-set-uuid
20517           in: path
20518           required: true
20519           type: string
20520           example: __CONSTRAINED-ELEMENT-SET-UUID__
20521         - name: model-type
20522           in: query
20523           description: Type of the model, e.g., service, resource, widget, etc.
20524           required: false
20525           type: string
20526         - name: model-name
20527           in: query
20528           description: Name of the model, which can change from version to version.
20529           required: false
20530           type: string
20531         - name: model-version
20532           in: query
20533           description: Version
20534           required: false
20535           type: string
20536         - name: distribution-status
20537           in: query
20538           description: Distribution Status
20539           required: false
20540           type: string
20541   /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:
20542     put:
20543       tags:
20544         - ServiceDesignAndCreation
20545       summary: see node definition for valid relationships
20546       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
20547       consumes:
20548         - application/json
20549         - application/xml
20550       produces:
20551         - application/json
20552         - application/xml
20553       responses:
20554         "default":
20555           description: Response codes found in [response codes](https://wiki.onap.org/).
20556       parameters:
20557         - name: model-invariant-id
20558           in: path
20559           description: Unique identifier corresponding to the main definition of a model in ASDC
20560           required: true
20561           type: string
20562           example: __MODEL-INVARIANT-ID__
20563         - name: model-version-id
20564           in: path
20565           description: Unique identifier corresponding to one version of a model in ASDC
20566           required: true
20567           type: string
20568           example: __MODEL-VERSION-ID__
20569         - name: model-element-uuid
20570           in: path
20571           required: true
20572           type: string
20573           example: __MODEL-ELEMENT-UUID__
20574         - name: model-constraint-uuid
20575           in: path
20576           required: true
20577           type: string
20578           example: __MODEL-CONSTRAINT-UUID__
20579         - name: constrained-element-set-uuid
20580           in: path
20581           required: true
20582           type: string
20583           example: __CONSTRAINED-ELEMENT-SET-UUID__
20584         - name: body
20585           in: body
20586           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
20587           required: true
20588           schema:
20589             $ref: "#/definitions/relationship"
20590     delete:
20591       tags:
20592         - ServiceDesignAndCreation
20593       summary: delete an existing relationship
20594       description: delete an existing relationship
20595       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
20596       consumes:
20597         - application/json
20598         - application/xml
20599       produces:
20600         - application/json
20601         - application/xml
20602       responses:
20603         "default":
20604           description: Response codes found in [response codes](https://wiki.onap.org/).
20605       parameters:
20606         - name: model-invariant-id
20607           in: path
20608           description: Unique identifier corresponding to the main definition of a model in ASDC
20609           required: true
20610           type: string
20611           example: __MODEL-INVARIANT-ID__
20612         - name: model-version-id
20613           in: path
20614           description: Unique identifier corresponding to one version of a model in ASDC
20615           required: true
20616           type: string
20617           example: __MODEL-VERSION-ID__
20618         - name: model-element-uuid
20619           in: path
20620           required: true
20621           type: string
20622           example: __MODEL-ELEMENT-UUID__
20623         - name: model-constraint-uuid
20624           in: path
20625           required: true
20626           type: string
20627           example: __MODEL-CONSTRAINT-UUID__
20628         - name: constrained-element-set-uuid
20629           in: path
20630           required: true
20631           type: string
20632           example: __CONSTRAINED-ELEMENT-SET-UUID__
20633   /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}:
20634     get:
20635       tags:
20636         - ServiceDesignAndCreation
20637       summary: returns constrained-element-set
20638       description: returns constrained-element-set
20639       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
20640       produces:
20641         - application/json
20642         - application/xml
20643       responses:
20644         "200":
20645           description: successful operation
20646           schema:
20647               $ref: "#/getDefinitions/constrained-element-set"
20648         "default":
20649           description: Response codes found in [response codes](https://wiki.onap.org/).
20650       parameters:
20651         - name: model-invariant-id
20652           in: path
20653           description: Unique identifier corresponding to the main definition of a model in ASDC
20654           required: true
20655           type: string
20656           example: __MODEL-INVARIANT-ID__
20657         - name: model-version-id
20658           in: path
20659           description: Unique identifier corresponding to one version of a model in ASDC
20660           required: true
20661           type: string
20662           example: __MODEL-VERSION-ID__
20663         - name: model-element-uuid
20664           in: path
20665           required: true
20666           type: string
20667           example: __MODEL-ELEMENT-UUID__
20668         - name: model-constraint-uuid
20669           in: path
20670           required: true
20671           type: string
20672           example: __MODEL-CONSTRAINT-UUID__
20673         - name: constrained-element-set-uuid
20674           in: path
20675           required: true
20676           type: string
20677           example: __CONSTRAINED-ELEMENT-SET-UUID__
20678         - name: model-type
20679           in: query
20680           description: Type of the model, e.g., service, resource, widget, etc.
20681           required: false
20682           type: string
20683         - name: model-name
20684           in: query
20685           description: Name of the model, which can change from version to version.
20686           required: false
20687           type: string
20688         - name: model-version
20689           in: query
20690           description: Version
20691           required: false
20692           type: string
20693         - name: distribution-status
20694           in: query
20695           description: Distribution Status
20696           required: false
20697           type: string
20698     put:
20699       tags:
20700         - ServiceDesignAndCreation
20701       summary: create or update an existing constrained-element-set
20702       description: |
20703         Create or update an existing constrained-element-set.
20704         #
20705         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
20706       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
20707       consumes:
20708         - application/json
20709         - application/xml
20710       produces:
20711         - application/json
20712         - application/xml
20713       responses:
20714         "default":
20715           description: Response codes found in [response codes](https://wiki.onap.org/).
20716       parameters:
20717         - name: model-invariant-id
20718           in: path
20719           description: Unique identifier corresponding to the main definition of a model in ASDC
20720           required: true
20721           type: string
20722           example: __MODEL-INVARIANT-ID__
20723         - name: model-version-id
20724           in: path
20725           description: Unique identifier corresponding to one version of a model in ASDC
20726           required: true
20727           type: string
20728           example: __MODEL-VERSION-ID__
20729         - name: model-element-uuid
20730           in: path
20731           required: true
20732           type: string
20733           example: __MODEL-ELEMENT-UUID__
20734         - name: model-constraint-uuid
20735           in: path
20736           required: true
20737           type: string
20738           example: __MODEL-CONSTRAINT-UUID__
20739         - name: constrained-element-set-uuid
20740           in: path
20741           required: true
20742           type: string
20743           example: __CONSTRAINED-ELEMENT-SET-UUID__
20744         - name: body
20745           in: body
20746           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
20747           required: true
20748           schema:
20749             $ref: "#/definitions/constrained-element-set"
20750     patch:
20751       tags:
20752         - ServiceDesignAndCreation
20753       summary: update an existing constrained-element-set
20754       description: |
20755         Update an existing constrained-element-set
20756         #
20757         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20758         The PUT operation will entirely replace an existing object.
20759         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.
20760         #
20761         Other differences between PUT and PATCH are:
20762         #
20763         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20764         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20765         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20766       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
20767       consumes:
20768         - application/json
20769         - application/xml
20770       produces:
20771         - application/json
20772         - application/xml
20773       responses:
20774         "default":
20775           description: Response codes found in [response codes](https://wiki.onap.org/).
20776       parameters:
20777         - name: model-invariant-id
20778           in: path
20779           description: Unique identifier corresponding to the main definition of a model in ASDC
20780           required: true
20781           type: string
20782           example: __MODEL-INVARIANT-ID__
20783         - name: model-version-id
20784           in: path
20785           description: Unique identifier corresponding to one version of a model in ASDC
20786           required: true
20787           type: string
20788           example: __MODEL-VERSION-ID__
20789         - name: model-element-uuid
20790           in: path
20791           required: true
20792           type: string
20793           example: __MODEL-ELEMENT-UUID__
20794         - name: model-constraint-uuid
20795           in: path
20796           required: true
20797           type: string
20798           example: __MODEL-CONSTRAINT-UUID__
20799         - name: constrained-element-set-uuid
20800           in: path
20801           required: true
20802           type: string
20803           example: __CONSTRAINED-ELEMENT-SET-UUID__
20804         - name: body
20805           in: body
20806           description: constrained-element-set object that needs to be created or updated.
20807           required: true
20808           schema:
20809             $ref: "#/patchDefinitions/constrained-element-set"
20810     delete:
20811       tags:
20812         - ServiceDesignAndCreation
20813       summary: delete an existing constrained-element-set
20814       description: delete an existing constrained-element-set
20815       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
20816       consumes:
20817         - application/json
20818         - application/xml
20819       produces:
20820         - application/json
20821         - application/xml
20822       responses:
20823         "default":
20824           description: Response codes found in [response codes](https://wiki.onap.org/).
20825       parameters:
20826         - name: model-invariant-id
20827           in: path
20828           description: Unique identifier corresponding to the main definition of a model in ASDC
20829           required: true
20830           type: string
20831           example: __MODEL-INVARIANT-ID__
20832         - name: model-version-id
20833           in: path
20834           description: Unique identifier corresponding to one version of a model in ASDC
20835           required: true
20836           type: string
20837           example: __MODEL-VERSION-ID__
20838         - name: model-element-uuid
20839           in: path
20840           required: true
20841           type: string
20842           example: __MODEL-ELEMENT-UUID__
20843         - name: model-constraint-uuid
20844           in: path
20845           required: true
20846           type: string
20847           example: __MODEL-CONSTRAINT-UUID__
20848         - name: constrained-element-set-uuid
20849           in: path
20850           required: true
20851           type: string
20852           example: __CONSTRAINED-ELEMENT-SET-UUID__
20853         - name: resource-version
20854           in: query
20855           description: resource-version for concurrency
20856           required: true
20857           type: string
20858   /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:
20859     get:
20860       tags:
20861         - ServiceDesignAndCreation
20862       summary: returns constrained-element-sets
20863       description: returns constrained-element-sets
20864       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
20865       produces:
20866         - application/json
20867         - application/xml
20868       responses:
20869         "200":
20870           description: successful operation
20871           schema:
20872               $ref: "#/getDefinitions/constrained-element-sets"
20873         "default":
20874           description: Response codes found in [response codes](https://wiki.onap.org/).
20875       parameters:
20876         - name: model-invariant-id
20877           in: path
20878           description: Unique identifier corresponding to the main definition of a model in ASDC
20879           required: true
20880           type: string
20881           example: __MODEL-INVARIANT-ID__
20882         - name: model-version-id
20883           in: path
20884           description: Unique identifier corresponding to one version of a model in ASDC
20885           required: true
20886           type: string
20887           example: __MODEL-VERSION-ID__
20888         - name: model-element-uuid
20889           in: path
20890           required: true
20891           type: string
20892           example: __MODEL-ELEMENT-UUID__
20893         - name: model-constraint-uuid
20894           in: path
20895           required: true
20896           type: string
20897           example: __MODEL-CONSTRAINT-UUID__
20898         - name: model-type
20899           in: query
20900           description: Type of the model, e.g., service, resource, widget, etc.
20901           required: false
20902           type: string
20903         - name: model-name
20904           in: query
20905           description: Name of the model, which can change from version to version.
20906           required: false
20907           type: string
20908         - name: model-version
20909           in: query
20910           description: Version
20911           required: false
20912           type: string
20913         - name: distribution-status
20914           in: query
20915           description: Distribution Status
20916           required: false
20917           type: string
20918   /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}:
20919     get:
20920       tags:
20921         - ServiceDesignAndCreation
20922       summary: returns model-constraint
20923       description: returns model-constraint
20924       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20925       produces:
20926         - application/json
20927         - application/xml
20928       responses:
20929         "200":
20930           description: successful operation
20931           schema:
20932               $ref: "#/getDefinitions/model-constraint"
20933         "default":
20934           description: Response codes found in [response codes](https://wiki.onap.org/).
20935       parameters:
20936         - name: model-invariant-id
20937           in: path
20938           description: Unique identifier corresponding to the main definition of a model in ASDC
20939           required: true
20940           type: string
20941           example: __MODEL-INVARIANT-ID__
20942         - name: model-version-id
20943           in: path
20944           description: Unique identifier corresponding to one version of a model in ASDC
20945           required: true
20946           type: string
20947           example: __MODEL-VERSION-ID__
20948         - name: model-element-uuid
20949           in: path
20950           required: true
20951           type: string
20952           example: __MODEL-ELEMENT-UUID__
20953         - name: model-constraint-uuid
20954           in: path
20955           required: true
20956           type: string
20957           example: __MODEL-CONSTRAINT-UUID__
20958         - name: model-type
20959           in: query
20960           description: Type of the model, e.g., service, resource, widget, etc.
20961           required: false
20962           type: string
20963         - name: model-name
20964           in: query
20965           description: Name of the model, which can change from version to version.
20966           required: false
20967           type: string
20968         - name: model-version
20969           in: query
20970           description: Version
20971           required: false
20972           type: string
20973         - name: distribution-status
20974           in: query
20975           description: Distribution Status
20976           required: false
20977           type: string
20978     put:
20979       tags:
20980         - ServiceDesignAndCreation
20981       summary: create or update an existing model-constraint
20982       description: |
20983         Create or update an existing model-constraint.
20984         #
20985         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
20986       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20987       consumes:
20988         - application/json
20989         - application/xml
20990       produces:
20991         - application/json
20992         - application/xml
20993       responses:
20994         "default":
20995           description: Response codes found in [response codes](https://wiki.onap.org/).
20996       parameters:
20997         - name: model-invariant-id
20998           in: path
20999           description: Unique identifier corresponding to the main definition of a model in ASDC
21000           required: true
21001           type: string
21002           example: __MODEL-INVARIANT-ID__
21003         - name: model-version-id
21004           in: path
21005           description: Unique identifier corresponding to one version of a model in ASDC
21006           required: true
21007           type: string
21008           example: __MODEL-VERSION-ID__
21009         - name: model-element-uuid
21010           in: path
21011           required: true
21012           type: string
21013           example: __MODEL-ELEMENT-UUID__
21014         - name: model-constraint-uuid
21015           in: path
21016           required: true
21017           type: string
21018           example: __MODEL-CONSTRAINT-UUID__
21019         - name: body
21020           in: body
21021           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
21022           required: true
21023           schema:
21024             $ref: "#/definitions/model-constraint"
21025     patch:
21026       tags:
21027         - ServiceDesignAndCreation
21028       summary: update an existing model-constraint
21029       description: |
21030         Update an existing model-constraint
21031         #
21032         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21033         The PUT operation will entirely replace an existing object.
21034         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.
21035         #
21036         Other differences between PUT and PATCH are:
21037         #
21038         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21039         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21040         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21041       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
21042       consumes:
21043         - application/json
21044         - application/xml
21045       produces:
21046         - application/json
21047         - application/xml
21048       responses:
21049         "default":
21050           description: Response codes found in [response codes](https://wiki.onap.org/).
21051       parameters:
21052         - name: model-invariant-id
21053           in: path
21054           description: Unique identifier corresponding to the main definition of a model in ASDC
21055           required: true
21056           type: string
21057           example: __MODEL-INVARIANT-ID__
21058         - name: model-version-id
21059           in: path
21060           description: Unique identifier corresponding to one version of a model in ASDC
21061           required: true
21062           type: string
21063           example: __MODEL-VERSION-ID__
21064         - name: model-element-uuid
21065           in: path
21066           required: true
21067           type: string
21068           example: __MODEL-ELEMENT-UUID__
21069         - name: model-constraint-uuid
21070           in: path
21071           required: true
21072           type: string
21073           example: __MODEL-CONSTRAINT-UUID__
21074         - name: body
21075           in: body
21076           description: model-constraint object that needs to be created or updated.
21077           required: true
21078           schema:
21079             $ref: "#/patchDefinitions/model-constraint"
21080     delete:
21081       tags:
21082         - ServiceDesignAndCreation
21083       summary: delete an existing model-constraint
21084       description: delete an existing model-constraint
21085       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
21086       consumes:
21087         - application/json
21088         - application/xml
21089       produces:
21090         - application/json
21091         - application/xml
21092       responses:
21093         "default":
21094           description: Response codes found in [response codes](https://wiki.onap.org/).
21095       parameters:
21096         - name: model-invariant-id
21097           in: path
21098           description: Unique identifier corresponding to the main definition of a model in ASDC
21099           required: true
21100           type: string
21101           example: __MODEL-INVARIANT-ID__
21102         - name: model-version-id
21103           in: path
21104           description: Unique identifier corresponding to one version of a model in ASDC
21105           required: true
21106           type: string
21107           example: __MODEL-VERSION-ID__
21108         - name: model-element-uuid
21109           in: path
21110           required: true
21111           type: string
21112           example: __MODEL-ELEMENT-UUID__
21113         - name: model-constraint-uuid
21114           in: path
21115           required: true
21116           type: string
21117           example: __MODEL-CONSTRAINT-UUID__
21118         - name: resource-version
21119           in: query
21120           description: resource-version for concurrency
21121           required: true
21122           type: string
21123   /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:
21124     get:
21125       tags:
21126         - ServiceDesignAndCreation
21127       summary: returns model-constraints
21128       description: returns model-constraints
21129       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
21130       produces:
21131         - application/json
21132         - application/xml
21133       responses:
21134         "200":
21135           description: successful operation
21136           schema:
21137               $ref: "#/getDefinitions/model-constraints"
21138         "default":
21139           description: Response codes found in [response codes](https://wiki.onap.org/).
21140       parameters:
21141         - name: model-invariant-id
21142           in: path
21143           description: Unique identifier corresponding to the main definition of a model in ASDC
21144           required: true
21145           type: string
21146           example: __MODEL-INVARIANT-ID__
21147         - name: model-version-id
21148           in: path
21149           description: Unique identifier corresponding to one version of a model in ASDC
21150           required: true
21151           type: string
21152           example: __MODEL-VERSION-ID__
21153         - name: model-element-uuid
21154           in: path
21155           required: true
21156           type: string
21157           example: __MODEL-ELEMENT-UUID__
21158         - name: model-type
21159           in: query
21160           description: Type of the model, e.g., service, resource, widget, etc.
21161           required: false
21162           type: string
21163         - name: model-name
21164           in: query
21165           description: Name of the model, which can change from version to version.
21166           required: false
21167           type: string
21168         - name: model-version
21169           in: query
21170           description: Version
21171           required: false
21172           type: string
21173         - name: distribution-status
21174           in: query
21175           description: Distribution Status
21176           required: false
21177           type: string
21178   /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:
21179     put:
21180       tags:
21181         - ServiceDesignAndCreation
21182       summary: see node definition for valid relationships
21183       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
21184       consumes:
21185         - application/json
21186         - application/xml
21187       produces:
21188         - application/json
21189         - application/xml
21190       responses:
21191         "default":
21192           description: Response codes found in [response codes](https://wiki.onap.org/).
21193       parameters:
21194         - name: model-invariant-id
21195           in: path
21196           description: Unique identifier corresponding to the main definition of a model in ASDC
21197           required: true
21198           type: string
21199           example: __MODEL-INVARIANT-ID__
21200         - name: model-version-id
21201           in: path
21202           description: Unique identifier corresponding to one version of a model in ASDC
21203           required: true
21204           type: string
21205           example: __MODEL-VERSION-ID__
21206         - name: model-element-uuid
21207           in: path
21208           required: true
21209           type: string
21210           example: __MODEL-ELEMENT-UUID__
21211         - name: body
21212           in: body
21213           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
21214           required: true
21215           schema:
21216             $ref: "#/definitions/relationship"
21217     delete:
21218       tags:
21219         - ServiceDesignAndCreation
21220       summary: delete an existing relationship
21221       description: delete an existing relationship
21222       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
21223       consumes:
21224         - application/json
21225         - application/xml
21226       produces:
21227         - application/json
21228         - application/xml
21229       responses:
21230         "default":
21231           description: Response codes found in [response codes](https://wiki.onap.org/).
21232       parameters:
21233         - name: model-invariant-id
21234           in: path
21235           description: Unique identifier corresponding to the main definition of a model in ASDC
21236           required: true
21237           type: string
21238           example: __MODEL-INVARIANT-ID__
21239         - name: model-version-id
21240           in: path
21241           description: Unique identifier corresponding to one version of a model in ASDC
21242           required: true
21243           type: string
21244           example: __MODEL-VERSION-ID__
21245         - name: model-element-uuid
21246           in: path
21247           required: true
21248           type: string
21249           example: __MODEL-ELEMENT-UUID__
21250   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
21251     get:
21252       tags:
21253         - ServiceDesignAndCreation
21254       summary: returns model-element
21255       description: returns model-element
21256       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21257       produces:
21258         - application/json
21259         - application/xml
21260       responses:
21261         "200":
21262           description: successful operation
21263           schema:
21264               $ref: "#/getDefinitions/model-element"
21265         "default":
21266           description: Response codes found in [response codes](https://wiki.onap.org/).
21267       parameters:
21268         - name: model-invariant-id
21269           in: path
21270           description: Unique identifier corresponding to the main definition of a model in ASDC
21271           required: true
21272           type: string
21273           example: __MODEL-INVARIANT-ID__
21274         - name: model-version-id
21275           in: path
21276           description: Unique identifier corresponding to one version of a model in ASDC
21277           required: true
21278           type: string
21279           example: __MODEL-VERSION-ID__
21280         - name: model-element-uuid
21281           in: path
21282           required: true
21283           type: string
21284           example: __MODEL-ELEMENT-UUID__
21285         - name: model-type
21286           in: query
21287           description: Type of the model, e.g., service, resource, widget, etc.
21288           required: false
21289           type: string
21290         - name: model-name
21291           in: query
21292           description: Name of the model, which can change from version to version.
21293           required: false
21294           type: string
21295         - name: model-version
21296           in: query
21297           description: Version
21298           required: false
21299           type: string
21300         - name: distribution-status
21301           in: query
21302           description: Distribution Status
21303           required: false
21304           type: string
21305     put:
21306       tags:
21307         - ServiceDesignAndCreation
21308       summary: create or update an existing model-element
21309       description: |
21310         Create or update an existing model-element.
21311         #
21312         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
21313       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21314       consumes:
21315         - application/json
21316         - application/xml
21317       produces:
21318         - application/json
21319         - application/xml
21320       responses:
21321         "default":
21322           description: Response codes found in [response codes](https://wiki.onap.org/).
21323       parameters:
21324         - name: model-invariant-id
21325           in: path
21326           description: Unique identifier corresponding to the main definition of a model in ASDC
21327           required: true
21328           type: string
21329           example: __MODEL-INVARIANT-ID__
21330         - name: model-version-id
21331           in: path
21332           description: Unique identifier corresponding to one version of a model in ASDC
21333           required: true
21334           type: string
21335           example: __MODEL-VERSION-ID__
21336         - name: model-element-uuid
21337           in: path
21338           required: true
21339           type: string
21340           example: __MODEL-ELEMENT-UUID__
21341         - name: body
21342           in: body
21343           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
21344           required: true
21345           schema:
21346             $ref: "#/definitions/model-element"
21347     patch:
21348       tags:
21349         - ServiceDesignAndCreation
21350       summary: update an existing model-element
21351       description: |
21352         Update an existing model-element
21353         #
21354         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21355         The PUT operation will entirely replace an existing object.
21356         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.
21357         #
21358         Other differences between PUT and PATCH are:
21359         #
21360         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21361         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21362         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21363       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21364       consumes:
21365         - application/json
21366         - application/xml
21367       produces:
21368         - application/json
21369         - application/xml
21370       responses:
21371         "default":
21372           description: Response codes found in [response codes](https://wiki.onap.org/).
21373       parameters:
21374         - name: model-invariant-id
21375           in: path
21376           description: Unique identifier corresponding to the main definition of a model in ASDC
21377           required: true
21378           type: string
21379           example: __MODEL-INVARIANT-ID__
21380         - name: model-version-id
21381           in: path
21382           description: Unique identifier corresponding to one version of a model in ASDC
21383           required: true
21384           type: string
21385           example: __MODEL-VERSION-ID__
21386         - name: model-element-uuid
21387           in: path
21388           required: true
21389           type: string
21390           example: __MODEL-ELEMENT-UUID__
21391         - name: body
21392           in: body
21393           description: model-element object that needs to be created or updated.
21394           required: true
21395           schema:
21396             $ref: "#/patchDefinitions/model-element"
21397     delete:
21398       tags:
21399         - ServiceDesignAndCreation
21400       summary: delete an existing model-element
21401       description: delete an existing model-element
21402       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
21403       consumes:
21404         - application/json
21405         - application/xml
21406       produces:
21407         - application/json
21408         - application/xml
21409       responses:
21410         "default":
21411           description: Response codes found in [response codes](https://wiki.onap.org/).
21412       parameters:
21413         - name: model-invariant-id
21414           in: path
21415           description: Unique identifier corresponding to the main definition of a model in ASDC
21416           required: true
21417           type: string
21418           example: __MODEL-INVARIANT-ID__
21419         - name: model-version-id
21420           in: path
21421           description: Unique identifier corresponding to one version of a model in ASDC
21422           required: true
21423           type: string
21424           example: __MODEL-VERSION-ID__
21425         - name: model-element-uuid
21426           in: path
21427           required: true
21428           type: string
21429           example: __MODEL-ELEMENT-UUID__
21430         - name: resource-version
21431           in: query
21432           description: resource-version for concurrency
21433           required: true
21434           type: string
21435   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
21436     get:
21437       tags:
21438         - ServiceDesignAndCreation
21439       summary: returns model-elements
21440       description: returns model-elements
21441       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
21442       produces:
21443         - application/json
21444         - application/xml
21445       responses:
21446         "200":
21447           description: successful operation
21448           schema:
21449               $ref: "#/getDefinitions/model-elements"
21450         "default":
21451           description: Response codes found in [response codes](https://wiki.onap.org/).
21452       parameters:
21453         - name: model-invariant-id
21454           in: path
21455           description: Unique identifier corresponding to the main definition of a model in ASDC
21456           required: true
21457           type: string
21458           example: __MODEL-INVARIANT-ID__
21459         - name: model-version-id
21460           in: path
21461           description: Unique identifier corresponding to one version of a model in ASDC
21462           required: true
21463           type: string
21464           example: __MODEL-VERSION-ID__
21465         - name: model-type
21466           in: query
21467           description: Type of the model, e.g., service, resource, widget, etc.
21468           required: false
21469           type: string
21470         - name: model-name
21471           in: query
21472           description: Name of the model, which can change from version to version.
21473           required: false
21474           type: string
21475         - name: model-version
21476           in: query
21477           description: Version
21478           required: false
21479           type: string
21480         - name: distribution-status
21481           in: query
21482           description: Distribution Status
21483           required: false
21484           type: string
21485   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
21486     get:
21487       tags:
21488         - ServiceDesignAndCreation
21489       summary: returns metadatum
21490       description: returns metadatum
21491       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21492       produces:
21493         - application/json
21494         - application/xml
21495       responses:
21496         "200":
21497           description: successful operation
21498           schema:
21499               $ref: "#/getDefinitions/metadatum"
21500         "default":
21501           description: Response codes found in [response codes](https://wiki.onap.org/).
21502       parameters:
21503         - name: model-invariant-id
21504           in: path
21505           description: Unique identifier corresponding to the main definition of a model in ASDC
21506           required: true
21507           type: string
21508           example: __MODEL-INVARIANT-ID__
21509         - name: model-version-id
21510           in: path
21511           description: Unique identifier corresponding to one version of a model in ASDC
21512           required: true
21513           type: string
21514           example: __MODEL-VERSION-ID__
21515         - name: metaname
21516           in: path
21517           required: true
21518           type: string
21519           example: __METANAME__
21520         - name: model-type
21521           in: query
21522           description: Type of the model, e.g., service, resource, widget, etc.
21523           required: false
21524           type: string
21525         - name: model-name
21526           in: query
21527           description: Name of the model, which can change from version to version.
21528           required: false
21529           type: string
21530         - name: model-version
21531           in: query
21532           description: Version
21533           required: false
21534           type: string
21535         - name: distribution-status
21536           in: query
21537           description: Distribution Status
21538           required: false
21539           type: string
21540     put:
21541       tags:
21542         - ServiceDesignAndCreation
21543       summary: create or update an existing metadatum
21544       description: |
21545         Create or update an existing metadatum.
21546         #
21547         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
21548       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21549       consumes:
21550         - application/json
21551         - application/xml
21552       produces:
21553         - application/json
21554         - application/xml
21555       responses:
21556         "default":
21557           description: Response codes found in [response codes](https://wiki.onap.org/).
21558       parameters:
21559         - name: model-invariant-id
21560           in: path
21561           description: Unique identifier corresponding to the main definition of a model in ASDC
21562           required: true
21563           type: string
21564           example: __MODEL-INVARIANT-ID__
21565         - name: model-version-id
21566           in: path
21567           description: Unique identifier corresponding to one version of a model in ASDC
21568           required: true
21569           type: string
21570           example: __MODEL-VERSION-ID__
21571         - name: metaname
21572           in: path
21573           required: true
21574           type: string
21575           example: __METANAME__
21576         - name: body
21577           in: body
21578           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
21579           required: true
21580           schema:
21581             $ref: "#/definitions/metadatum"
21582     patch:
21583       tags:
21584         - ServiceDesignAndCreation
21585       summary: update an existing metadatum
21586       description: |
21587         Update an existing metadatum
21588         #
21589         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21590         The PUT operation will entirely replace an existing object.
21591         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.
21592         #
21593         Other differences between PUT and PATCH are:
21594         #
21595         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21596         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21597         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21598       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21599       consumes:
21600         - application/json
21601         - application/xml
21602       produces:
21603         - application/json
21604         - application/xml
21605       responses:
21606         "default":
21607           description: Response codes found in [response codes](https://wiki.onap.org/).
21608       parameters:
21609         - name: model-invariant-id
21610           in: path
21611           description: Unique identifier corresponding to the main definition of a model in ASDC
21612           required: true
21613           type: string
21614           example: __MODEL-INVARIANT-ID__
21615         - name: model-version-id
21616           in: path
21617           description: Unique identifier corresponding to one version of a model in ASDC
21618           required: true
21619           type: string
21620           example: __MODEL-VERSION-ID__
21621         - name: metaname
21622           in: path
21623           required: true
21624           type: string
21625           example: __METANAME__
21626         - name: body
21627           in: body
21628           description: metadatum object that needs to be created or updated.
21629           required: true
21630           schema:
21631             $ref: "#/patchDefinitions/metadatum"
21632     delete:
21633       tags:
21634         - ServiceDesignAndCreation
21635       summary: delete an existing metadatum
21636       description: delete an existing metadatum
21637       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
21638       consumes:
21639         - application/json
21640         - application/xml
21641       produces:
21642         - application/json
21643         - application/xml
21644       responses:
21645         "default":
21646           description: Response codes found in [response codes](https://wiki.onap.org/).
21647       parameters:
21648         - name: model-invariant-id
21649           in: path
21650           description: Unique identifier corresponding to the main definition of a model in ASDC
21651           required: true
21652           type: string
21653           example: __MODEL-INVARIANT-ID__
21654         - name: model-version-id
21655           in: path
21656           description: Unique identifier corresponding to one version of a model in ASDC
21657           required: true
21658           type: string
21659           example: __MODEL-VERSION-ID__
21660         - name: metaname
21661           in: path
21662           required: true
21663           type: string
21664           example: __METANAME__
21665         - name: resource-version
21666           in: query
21667           description: resource-version for concurrency
21668           required: true
21669           type: string
21670   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
21671     get:
21672       tags:
21673         - ServiceDesignAndCreation
21674       summary: returns metadata
21675       description: returns metadata
21676       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
21677       produces:
21678         - application/json
21679         - application/xml
21680       responses:
21681         "200":
21682           description: successful operation
21683           schema:
21684               $ref: "#/getDefinitions/metadata"
21685         "default":
21686           description: Response codes found in [response codes](https://wiki.onap.org/).
21687       parameters:
21688         - name: model-invariant-id
21689           in: path
21690           description: Unique identifier corresponding to the main definition of a model in ASDC
21691           required: true
21692           type: string
21693           example: __MODEL-INVARIANT-ID__
21694         - name: model-version-id
21695           in: path
21696           description: Unique identifier corresponding to one version of a model in ASDC
21697           required: true
21698           type: string
21699           example: __MODEL-VERSION-ID__
21700         - name: model-type
21701           in: query
21702           description: Type of the model, e.g., service, resource, widget, etc.
21703           required: false
21704           type: string
21705         - name: model-name
21706           in: query
21707           description: Name of the model, which can change from version to version.
21708           required: false
21709           type: string
21710         - name: model-version
21711           in: query
21712           description: Version
21713           required: false
21714           type: string
21715         - name: distribution-status
21716           in: query
21717           description: Distribution Status
21718           required: false
21719           type: string
21720   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
21721     put:
21722       tags:
21723         - ServiceDesignAndCreation
21724       summary: see node definition for valid relationships
21725       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
21726       consumes:
21727         - application/json
21728         - application/xml
21729       produces:
21730         - application/json
21731         - application/xml
21732       responses:
21733         "default":
21734           description: Response codes found in [response codes](https://wiki.onap.org/).
21735       parameters:
21736         - name: model-invariant-id
21737           in: path
21738           description: Unique identifier corresponding to the main definition of a model in ASDC
21739           required: true
21740           type: string
21741           example: __MODEL-INVARIANT-ID__
21742         - name: model-version-id
21743           in: path
21744           description: Unique identifier corresponding to one version of a model in ASDC
21745           required: true
21746           type: string
21747           example: __MODEL-VERSION-ID__
21748         - name: body
21749           in: body
21750           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
21751           required: true
21752           schema:
21753             $ref: "#/definitions/relationship"
21754     delete:
21755       tags:
21756         - ServiceDesignAndCreation
21757       summary: delete an existing relationship
21758       description: delete an existing relationship
21759       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
21760       consumes:
21761         - application/json
21762         - application/xml
21763       produces:
21764         - application/json
21765         - application/xml
21766       responses:
21767         "default":
21768           description: Response codes found in [response codes](https://wiki.onap.org/).
21769       parameters:
21770         - name: model-invariant-id
21771           in: path
21772           description: Unique identifier corresponding to the main definition of a model in ASDC
21773           required: true
21774           type: string
21775           example: __MODEL-INVARIANT-ID__
21776         - name: model-version-id
21777           in: path
21778           description: Unique identifier corresponding to one version of a model in ASDC
21779           required: true
21780           type: string
21781           example: __MODEL-VERSION-ID__
21782   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
21783     get:
21784       tags:
21785         - ServiceDesignAndCreation
21786       summary: returns model-ver
21787       description: returns model-ver
21788       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
21789       produces:
21790         - application/json
21791         - application/xml
21792       responses:
21793         "200":
21794           description: successful operation
21795           schema:
21796               $ref: "#/getDefinitions/model-ver"
21797         "default":
21798           description: Response codes found in [response codes](https://wiki.onap.org/).
21799       parameters:
21800         - name: model-invariant-id
21801           in: path
21802           description: Unique identifier corresponding to the main definition of a model in ASDC
21803           required: true
21804           type: string
21805           example: __MODEL-INVARIANT-ID__
21806         - name: model-version-id
21807           in: path
21808           description: Unique identifier corresponding to one version of a model in ASDC
21809           required: true
21810           type: string
21811           example: __MODEL-VERSION-ID__
21812         - name: model-type
21813           in: query
21814           description: Type of the model, e.g., service, resource, widget, etc.
21815           required: false
21816           type: string
21817         - name: model-name
21818           in: query
21819           description: Name of the model, which can change from version to version.
21820           required: false
21821           type: string
21822         - name: model-version
21823           in: query
21824           description: Version
21825           required: false
21826           type: string
21827         - name: distribution-status
21828           in: query
21829           description: Distribution Status
21830           required: false
21831           type: string
21832     put:
21833       tags:
21834         - ServiceDesignAndCreation
21835       summary: create or update an existing model-ver
21836       description: |
21837         Create or update an existing model-ver.
21838         #
21839         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
21840       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
21841       consumes:
21842         - application/json
21843         - application/xml
21844       produces:
21845         - application/json
21846         - application/xml
21847       responses:
21848         "default":
21849           description: Response codes found in [response codes](https://wiki.onap.org/).
21850       parameters:
21851         - name: model-invariant-id
21852           in: path
21853           description: Unique identifier corresponding to the main definition of a model in ASDC
21854           required: true
21855           type: string
21856           example: __MODEL-INVARIANT-ID__
21857         - name: model-version-id
21858           in: path
21859           description: Unique identifier corresponding to one version of a model in ASDC
21860           required: true
21861           type: string
21862           example: __MODEL-VERSION-ID__
21863         - name: body
21864           in: body
21865           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
21866           required: true
21867           schema:
21868             $ref: "#/definitions/model-ver"
21869     patch:
21870       tags:
21871         - ServiceDesignAndCreation
21872       summary: update an existing model-ver
21873       description: |
21874         Update an existing model-ver
21875         #
21876         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21877         The PUT operation will entirely replace an existing object.
21878         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.
21879         #
21880         Other differences between PUT and PATCH are:
21881         #
21882         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21883         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21884         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21885       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
21886       consumes:
21887         - application/json
21888         - application/xml
21889       produces:
21890         - application/json
21891         - application/xml
21892       responses:
21893         "default":
21894           description: Response codes found in [response codes](https://wiki.onap.org/).
21895       parameters:
21896         - name: model-invariant-id
21897           in: path
21898           description: Unique identifier corresponding to the main definition of a model in ASDC
21899           required: true
21900           type: string
21901           example: __MODEL-INVARIANT-ID__
21902         - name: model-version-id
21903           in: path
21904           description: Unique identifier corresponding to one version of a model in ASDC
21905           required: true
21906           type: string
21907           example: __MODEL-VERSION-ID__
21908         - name: body
21909           in: body
21910           description: model-ver object that needs to be created or updated.
21911           required: true
21912           schema:
21913             $ref: "#/patchDefinitions/model-ver"
21914     delete:
21915       tags:
21916         - ServiceDesignAndCreation
21917       summary: delete an existing model-ver
21918       description: delete an existing model-ver
21919       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
21920       consumes:
21921         - application/json
21922         - application/xml
21923       produces:
21924         - application/json
21925         - application/xml
21926       responses:
21927         "default":
21928           description: Response codes found in [response codes](https://wiki.onap.org/).
21929       parameters:
21930         - name: model-invariant-id
21931           in: path
21932           description: Unique identifier corresponding to the main definition of a model in ASDC
21933           required: true
21934           type: string
21935           example: __MODEL-INVARIANT-ID__
21936         - name: model-version-id
21937           in: path
21938           description: Unique identifier corresponding to one version of a model in ASDC
21939           required: true
21940           type: string
21941           example: __MODEL-VERSION-ID__
21942         - name: resource-version
21943           in: query
21944           description: resource-version for concurrency
21945           required: true
21946           type: string
21947   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
21948     get:
21949       tags:
21950         - ServiceDesignAndCreation
21951       summary: returns model-vers
21952       description: returns model-vers
21953       operationId: getServiceDesignAndCreationModelsModelModelVers
21954       produces:
21955         - application/json
21956         - application/xml
21957       responses:
21958         "200":
21959           description: successful operation
21960           schema:
21961               $ref: "#/getDefinitions/model-vers"
21962         "default":
21963           description: Response codes found in [response codes](https://wiki.onap.org/).
21964       parameters:
21965         - name: model-invariant-id
21966           in: path
21967           description: Unique identifier corresponding to the main definition of a model in ASDC
21968           required: true
21969           type: string
21970           example: __MODEL-INVARIANT-ID__
21971         - name: model-type
21972           in: query
21973           description: Type of the model, e.g., service, resource, widget, etc.
21974           required: false
21975           type: string
21976   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
21977     put:
21978       tags:
21979         - ServiceDesignAndCreation
21980       summary: see node definition for valid relationships
21981       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
21982       consumes:
21983         - application/json
21984         - application/xml
21985       produces:
21986         - application/json
21987         - application/xml
21988       responses:
21989         "default":
21990           description: Response codes found in [response codes](https://wiki.onap.org/).
21991       parameters:
21992         - name: model-invariant-id
21993           in: path
21994           description: Unique identifier corresponding to the main definition of a model in ASDC
21995           required: true
21996           type: string
21997           example: __MODEL-INVARIANT-ID__
21998         - name: body
21999           in: body
22000           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
22001           required: true
22002           schema:
22003             $ref: "#/definitions/relationship"
22004     delete:
22005       tags:
22006         - ServiceDesignAndCreation
22007       summary: delete an existing relationship
22008       description: delete an existing relationship
22009       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
22010       consumes:
22011         - application/json
22012         - application/xml
22013       produces:
22014         - application/json
22015         - application/xml
22016       responses:
22017         "default":
22018           description: Response codes found in [response codes](https://wiki.onap.org/).
22019       parameters:
22020         - name: model-invariant-id
22021           in: path
22022           description: Unique identifier corresponding to the main definition of a model in ASDC
22023           required: true
22024           type: string
22025           example: __MODEL-INVARIANT-ID__
22026   /service-design-and-creation/models/model/{model-invariant-id}:
22027     get:
22028       tags:
22029         - ServiceDesignAndCreation
22030       summary: returns model
22031       description: returns model
22032       operationId: getServiceDesignAndCreationModelsModel
22033       produces:
22034         - application/json
22035         - application/xml
22036       responses:
22037         "200":
22038           description: successful operation
22039           schema:
22040               $ref: "#/getDefinitions/model"
22041         "default":
22042           description: Response codes found in [response codes](https://wiki.onap.org/).
22043       parameters:
22044         - name: model-invariant-id
22045           in: path
22046           description: Unique identifier corresponding to the main definition of a model in ASDC
22047           required: true
22048           type: string
22049           example: __MODEL-INVARIANT-ID__
22050         - name: model-type
22051           in: query
22052           description: Type of the model, e.g., service, resource, widget, etc.
22053           required: false
22054           type: string
22055     put:
22056       tags:
22057         - ServiceDesignAndCreation
22058       summary: create or update an existing model
22059       description: |
22060         Create or update an existing model.
22061         #
22062         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
22063       operationId: createOrUpdateServiceDesignAndCreationModelsModel
22064       consumes:
22065         - application/json
22066         - application/xml
22067       produces:
22068         - application/json
22069         - application/xml
22070       responses:
22071         "default":
22072           description: Response codes found in [response codes](https://wiki.onap.org/).
22073       parameters:
22074         - name: model-invariant-id
22075           in: path
22076           description: Unique identifier corresponding to the main definition of a model in ASDC
22077           required: true
22078           type: string
22079           example: __MODEL-INVARIANT-ID__
22080         - name: body
22081           in: body
22082           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
22083           required: true
22084           schema:
22085             $ref: "#/definitions/model"
22086     patch:
22087       tags:
22088         - ServiceDesignAndCreation
22089       summary: update an existing model
22090       description: |
22091         Update an existing model
22092         #
22093         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22094         The PUT operation will entirely replace an existing object.
22095         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.
22096         #
22097         Other differences between PUT and PATCH are:
22098         #
22099         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22100         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22101         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22102       operationId: UpdateServiceDesignAndCreationModelsModel
22103       consumes:
22104         - application/json
22105         - application/xml
22106       produces:
22107         - application/json
22108         - application/xml
22109       responses:
22110         "default":
22111           description: Response codes found in [response codes](https://wiki.onap.org/).
22112       parameters:
22113         - name: model-invariant-id
22114           in: path
22115           description: Unique identifier corresponding to the main definition of a model in ASDC
22116           required: true
22117           type: string
22118           example: __MODEL-INVARIANT-ID__
22119         - name: body
22120           in: body
22121           description: model object that needs to be created or updated.
22122           required: true
22123           schema:
22124             $ref: "#/patchDefinitions/model"
22125     delete:
22126       tags:
22127         - ServiceDesignAndCreation
22128       summary: delete an existing model
22129       description: delete an existing model
22130       operationId: deleteServiceDesignAndCreationModelsModel
22131       consumes:
22132         - application/json
22133         - application/xml
22134       produces:
22135         - application/json
22136         - application/xml
22137       responses:
22138         "default":
22139           description: Response codes found in [response codes](https://wiki.onap.org/).
22140       parameters:
22141         - name: model-invariant-id
22142           in: path
22143           description: Unique identifier corresponding to the main definition of a model in ASDC
22144           required: true
22145           type: string
22146           example: __MODEL-INVARIANT-ID__
22147         - name: resource-version
22148           in: query
22149           description: resource-version for concurrency
22150           required: true
22151           type: string
22152   /service-design-and-creation/models:
22153     get:
22154       tags:
22155         - ServiceDesignAndCreation
22156       summary: returns models
22157       description: returns models
22158       operationId: getServiceDesignAndCreationModels
22159       produces:
22160         - application/json
22161         - application/xml
22162       responses:
22163         "200":
22164           description: successful operation
22165           schema:
22166               $ref: "#/getDefinitions/models"
22167         "default":
22168           description: Response codes found in [response codes](https://wiki.onap.org/).
22169   /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:
22170     put:
22171       tags:
22172         - ServiceDesignAndCreation
22173       summary: see node definition for valid relationships
22174       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
22175       consumes:
22176         - application/json
22177         - application/xml
22178       produces:
22179         - application/json
22180         - application/xml
22181       responses:
22182         "default":
22183           description: Response codes found in [response codes](https://wiki.onap.org/).
22184       parameters:
22185         - name: named-query-uuid
22186           in: path
22187           required: true
22188           type: string
22189           example: __NAMED-QUERY-UUID__
22190         - name: named-query-element-uuid
22191           in: path
22192           required: true
22193           type: string
22194           example: __NAMED-QUERY-ELEMENT-UUID__
22195         - name: related-lookup-uuid
22196           in: path
22197           required: true
22198           type: string
22199           example: __RELATED-LOOKUP-UUID__
22200         - name: body
22201           in: body
22202           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
22203           required: true
22204           schema:
22205             $ref: "#/definitions/relationship"
22206     delete:
22207       tags:
22208         - ServiceDesignAndCreation
22209       summary: delete an existing relationship
22210       description: delete an existing relationship
22211       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
22212       consumes:
22213         - application/json
22214         - application/xml
22215       produces:
22216         - application/json
22217         - application/xml
22218       responses:
22219         "default":
22220           description: Response codes found in [response codes](https://wiki.onap.org/).
22221       parameters:
22222         - name: named-query-uuid
22223           in: path
22224           required: true
22225           type: string
22226           example: __NAMED-QUERY-UUID__
22227         - name: named-query-element-uuid
22228           in: path
22229           required: true
22230           type: string
22231           example: __NAMED-QUERY-ELEMENT-UUID__
22232         - name: related-lookup-uuid
22233           in: path
22234           required: true
22235           type: string
22236           example: __RELATED-LOOKUP-UUID__
22237   /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}:
22238     get:
22239       tags:
22240         - ServiceDesignAndCreation
22241       summary: returns related-lookup
22242       description: returns related-lookup
22243       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22244       produces:
22245         - application/json
22246         - application/xml
22247       responses:
22248         "200":
22249           description: successful operation
22250           schema:
22251               $ref: "#/getDefinitions/related-lookup"
22252         "default":
22253           description: Response codes found in [response codes](https://wiki.onap.org/).
22254       parameters:
22255         - name: named-query-uuid
22256           in: path
22257           required: true
22258           type: string
22259           example: __NAMED-QUERY-UUID__
22260         - name: named-query-element-uuid
22261           in: path
22262           required: true
22263           type: string
22264           example: __NAMED-QUERY-ELEMENT-UUID__
22265         - name: related-lookup-uuid
22266           in: path
22267           required: true
22268           type: string
22269           example: __RELATED-LOOKUP-UUID__
22270         - name: named-query-name
22271           in: query
22272           required: false
22273           type: string
22274     put:
22275       tags:
22276         - ServiceDesignAndCreation
22277       summary: create or update an existing related-lookup
22278       description: |
22279         Create or update an existing related-lookup.
22280         #
22281         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
22282       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22283       consumes:
22284         - application/json
22285         - application/xml
22286       produces:
22287         - application/json
22288         - application/xml
22289       responses:
22290         "default":
22291           description: Response codes found in [response codes](https://wiki.onap.org/).
22292       parameters:
22293         - name: named-query-uuid
22294           in: path
22295           required: true
22296           type: string
22297           example: __NAMED-QUERY-UUID__
22298         - name: named-query-element-uuid
22299           in: path
22300           required: true
22301           type: string
22302           example: __NAMED-QUERY-ELEMENT-UUID__
22303         - name: related-lookup-uuid
22304           in: path
22305           required: true
22306           type: string
22307           example: __RELATED-LOOKUP-UUID__
22308         - name: body
22309           in: body
22310           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
22311           required: true
22312           schema:
22313             $ref: "#/definitions/related-lookup"
22314     patch:
22315       tags:
22316         - ServiceDesignAndCreation
22317       summary: update an existing related-lookup
22318       description: |
22319         Update an existing related-lookup
22320         #
22321         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22322         The PUT operation will entirely replace an existing object.
22323         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.
22324         #
22325         Other differences between PUT and PATCH are:
22326         #
22327         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22328         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22329         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22330       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22331       consumes:
22332         - application/json
22333         - application/xml
22334       produces:
22335         - application/json
22336         - application/xml
22337       responses:
22338         "default":
22339           description: Response codes found in [response codes](https://wiki.onap.org/).
22340       parameters:
22341         - name: named-query-uuid
22342           in: path
22343           required: true
22344           type: string
22345           example: __NAMED-QUERY-UUID__
22346         - name: named-query-element-uuid
22347           in: path
22348           required: true
22349           type: string
22350           example: __NAMED-QUERY-ELEMENT-UUID__
22351         - name: related-lookup-uuid
22352           in: path
22353           required: true
22354           type: string
22355           example: __RELATED-LOOKUP-UUID__
22356         - name: body
22357           in: body
22358           description: related-lookup object that needs to be created or updated.
22359           required: true
22360           schema:
22361             $ref: "#/patchDefinitions/related-lookup"
22362     delete:
22363       tags:
22364         - ServiceDesignAndCreation
22365       summary: delete an existing related-lookup
22366       description: delete an existing related-lookup
22367       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
22368       consumes:
22369         - application/json
22370         - application/xml
22371       produces:
22372         - application/json
22373         - application/xml
22374       responses:
22375         "default":
22376           description: Response codes found in [response codes](https://wiki.onap.org/).
22377       parameters:
22378         - name: named-query-uuid
22379           in: path
22380           required: true
22381           type: string
22382           example: __NAMED-QUERY-UUID__
22383         - name: named-query-element-uuid
22384           in: path
22385           required: true
22386           type: string
22387           example: __NAMED-QUERY-ELEMENT-UUID__
22388         - name: related-lookup-uuid
22389           in: path
22390           required: true
22391           type: string
22392           example: __RELATED-LOOKUP-UUID__
22393         - name: resource-version
22394           in: query
22395           description: resource-version for concurrency
22396           required: true
22397           type: string
22398   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
22399     get:
22400       tags:
22401         - ServiceDesignAndCreation
22402       summary: returns related-lookups
22403       description: returns related-lookups
22404       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
22405       produces:
22406         - application/json
22407         - application/xml
22408       responses:
22409         "200":
22410           description: successful operation
22411           schema:
22412               $ref: "#/getDefinitions/related-lookups"
22413         "default":
22414           description: Response codes found in [response codes](https://wiki.onap.org/).
22415       parameters:
22416         - name: named-query-uuid
22417           in: path
22418           required: true
22419           type: string
22420           example: __NAMED-QUERY-UUID__
22421         - name: named-query-element-uuid
22422           in: path
22423           required: true
22424           type: string
22425           example: __NAMED-QUERY-ELEMENT-UUID__
22426         - name: named-query-name
22427           in: query
22428           required: false
22429           type: string
22430   /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}:
22431     get:
22432       tags:
22433         - ServiceDesignAndCreation
22434       summary: returns property-constraint
22435       description: returns property-constraint
22436       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22437       produces:
22438         - application/json
22439         - application/xml
22440       responses:
22441         "200":
22442           description: successful operation
22443           schema:
22444               $ref: "#/getDefinitions/property-constraint"
22445         "default":
22446           description: Response codes found in [response codes](https://wiki.onap.org/).
22447       parameters:
22448         - name: named-query-uuid
22449           in: path
22450           required: true
22451           type: string
22452           example: __NAMED-QUERY-UUID__
22453         - name: named-query-element-uuid
22454           in: path
22455           required: true
22456           type: string
22457           example: __NAMED-QUERY-ELEMENT-UUID__
22458         - name: property-constraint-uuid
22459           in: path
22460           required: true
22461           type: string
22462           example: __PROPERTY-CONSTRAINT-UUID__
22463         - name: named-query-name
22464           in: query
22465           required: false
22466           type: string
22467     put:
22468       tags:
22469         - ServiceDesignAndCreation
22470       summary: create or update an existing property-constraint
22471       description: |
22472         Create or update an existing property-constraint.
22473         #
22474         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
22475       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22476       consumes:
22477         - application/json
22478         - application/xml
22479       produces:
22480         - application/json
22481         - application/xml
22482       responses:
22483         "default":
22484           description: Response codes found in [response codes](https://wiki.onap.org/).
22485       parameters:
22486         - name: named-query-uuid
22487           in: path
22488           required: true
22489           type: string
22490           example: __NAMED-QUERY-UUID__
22491         - name: named-query-element-uuid
22492           in: path
22493           required: true
22494           type: string
22495           example: __NAMED-QUERY-ELEMENT-UUID__
22496         - name: property-constraint-uuid
22497           in: path
22498           required: true
22499           type: string
22500           example: __PROPERTY-CONSTRAINT-UUID__
22501         - name: body
22502           in: body
22503           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
22504           required: true
22505           schema:
22506             $ref: "#/definitions/property-constraint"
22507     patch:
22508       tags:
22509         - ServiceDesignAndCreation
22510       summary: update an existing property-constraint
22511       description: |
22512         Update an existing property-constraint
22513         #
22514         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22515         The PUT operation will entirely replace an existing object.
22516         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.
22517         #
22518         Other differences between PUT and PATCH are:
22519         #
22520         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22521         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22522         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22523       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22524       consumes:
22525         - application/json
22526         - application/xml
22527       produces:
22528         - application/json
22529         - application/xml
22530       responses:
22531         "default":
22532           description: Response codes found in [response codes](https://wiki.onap.org/).
22533       parameters:
22534         - name: named-query-uuid
22535           in: path
22536           required: true
22537           type: string
22538           example: __NAMED-QUERY-UUID__
22539         - name: named-query-element-uuid
22540           in: path
22541           required: true
22542           type: string
22543           example: __NAMED-QUERY-ELEMENT-UUID__
22544         - name: property-constraint-uuid
22545           in: path
22546           required: true
22547           type: string
22548           example: __PROPERTY-CONSTRAINT-UUID__
22549         - name: body
22550           in: body
22551           description: property-constraint object that needs to be created or updated.
22552           required: true
22553           schema:
22554             $ref: "#/patchDefinitions/property-constraint"
22555     delete:
22556       tags:
22557         - ServiceDesignAndCreation
22558       summary: delete an existing property-constraint
22559       description: delete an existing property-constraint
22560       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
22561       consumes:
22562         - application/json
22563         - application/xml
22564       produces:
22565         - application/json
22566         - application/xml
22567       responses:
22568         "default":
22569           description: Response codes found in [response codes](https://wiki.onap.org/).
22570       parameters:
22571         - name: named-query-uuid
22572           in: path
22573           required: true
22574           type: string
22575           example: __NAMED-QUERY-UUID__
22576         - name: named-query-element-uuid
22577           in: path
22578           required: true
22579           type: string
22580           example: __NAMED-QUERY-ELEMENT-UUID__
22581         - name: property-constraint-uuid
22582           in: path
22583           required: true
22584           type: string
22585           example: __PROPERTY-CONSTRAINT-UUID__
22586         - name: resource-version
22587           in: query
22588           description: resource-version for concurrency
22589           required: true
22590           type: string
22591   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
22592     get:
22593       tags:
22594         - ServiceDesignAndCreation
22595       summary: returns property-constraints
22596       description: returns property-constraints
22597       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
22598       produces:
22599         - application/json
22600         - application/xml
22601       responses:
22602         "200":
22603           description: successful operation
22604           schema:
22605               $ref: "#/getDefinitions/property-constraints"
22606         "default":
22607           description: Response codes found in [response codes](https://wiki.onap.org/).
22608       parameters:
22609         - name: named-query-uuid
22610           in: path
22611           required: true
22612           type: string
22613           example: __NAMED-QUERY-UUID__
22614         - name: named-query-element-uuid
22615           in: path
22616           required: true
22617           type: string
22618           example: __NAMED-QUERY-ELEMENT-UUID__
22619         - name: named-query-name
22620           in: query
22621           required: false
22622           type: string
22623   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
22624     put:
22625       tags:
22626         - ServiceDesignAndCreation
22627       summary: see node definition for valid relationships
22628       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
22629       consumes:
22630         - application/json
22631         - application/xml
22632       produces:
22633         - application/json
22634         - application/xml
22635       responses:
22636         "default":
22637           description: Response codes found in [response codes](https://wiki.onap.org/).
22638       parameters:
22639         - name: named-query-uuid
22640           in: path
22641           required: true
22642           type: string
22643           example: __NAMED-QUERY-UUID__
22644         - name: named-query-element-uuid
22645           in: path
22646           required: true
22647           type: string
22648           example: __NAMED-QUERY-ELEMENT-UUID__
22649         - name: body
22650           in: body
22651           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
22652           required: true
22653           schema:
22654             $ref: "#/definitions/relationship"
22655     delete:
22656       tags:
22657         - ServiceDesignAndCreation
22658       summary: delete an existing relationship
22659       description: delete an existing relationship
22660       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
22661       consumes:
22662         - application/json
22663         - application/xml
22664       produces:
22665         - application/json
22666         - application/xml
22667       responses:
22668         "default":
22669           description: Response codes found in [response codes](https://wiki.onap.org/).
22670       parameters:
22671         - name: named-query-uuid
22672           in: path
22673           required: true
22674           type: string
22675           example: __NAMED-QUERY-UUID__
22676         - name: named-query-element-uuid
22677           in: path
22678           required: true
22679           type: string
22680           example: __NAMED-QUERY-ELEMENT-UUID__
22681   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
22682     get:
22683       tags:
22684         - ServiceDesignAndCreation
22685       summary: returns named-query-element
22686       description: returns named-query-element
22687       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
22688       produces:
22689         - application/json
22690         - application/xml
22691       responses:
22692         "200":
22693           description: successful operation
22694           schema:
22695               $ref: "#/getDefinitions/named-query-element"
22696         "default":
22697           description: Response codes found in [response codes](https://wiki.onap.org/).
22698       parameters:
22699         - name: named-query-uuid
22700           in: path
22701           required: true
22702           type: string
22703           example: __NAMED-QUERY-UUID__
22704         - name: named-query-element-uuid
22705           in: path
22706           required: true
22707           type: string
22708           example: __NAMED-QUERY-ELEMENT-UUID__
22709         - name: named-query-name
22710           in: query
22711           required: false
22712           type: string
22713     put:
22714       tags:
22715         - ServiceDesignAndCreation
22716       summary: create or update an existing named-query-element
22717       description: |
22718         Create or update an existing named-query-element.
22719         #
22720         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
22721       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
22722       consumes:
22723         - application/json
22724         - application/xml
22725       produces:
22726         - application/json
22727         - application/xml
22728       responses:
22729         "default":
22730           description: Response codes found in [response codes](https://wiki.onap.org/).
22731       parameters:
22732         - name: named-query-uuid
22733           in: path
22734           required: true
22735           type: string
22736           example: __NAMED-QUERY-UUID__
22737         - name: named-query-element-uuid
22738           in: path
22739           required: true
22740           type: string
22741           example: __NAMED-QUERY-ELEMENT-UUID__
22742         - name: body
22743           in: body
22744           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
22745           required: true
22746           schema:
22747             $ref: "#/definitions/named-query-element"
22748     patch:
22749       tags:
22750         - ServiceDesignAndCreation
22751       summary: update an existing named-query-element
22752       description: |
22753         Update an existing named-query-element
22754         #
22755         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22756         The PUT operation will entirely replace an existing object.
22757         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.
22758         #
22759         Other differences between PUT and PATCH are:
22760         #
22761         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22762         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22763         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22764       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
22765       consumes:
22766         - application/json
22767         - application/xml
22768       produces:
22769         - application/json
22770         - application/xml
22771       responses:
22772         "default":
22773           description: Response codes found in [response codes](https://wiki.onap.org/).
22774       parameters:
22775         - name: named-query-uuid
22776           in: path
22777           required: true
22778           type: string
22779           example: __NAMED-QUERY-UUID__
22780         - name: named-query-element-uuid
22781           in: path
22782           required: true
22783           type: string
22784           example: __NAMED-QUERY-ELEMENT-UUID__
22785         - name: body
22786           in: body
22787           description: named-query-element object that needs to be created or updated.
22788           required: true
22789           schema:
22790             $ref: "#/patchDefinitions/named-query-element"
22791     delete:
22792       tags:
22793         - ServiceDesignAndCreation
22794       summary: delete an existing named-query-element
22795       description: delete an existing named-query-element
22796       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
22797       consumes:
22798         - application/json
22799         - application/xml
22800       produces:
22801         - application/json
22802         - application/xml
22803       responses:
22804         "default":
22805           description: Response codes found in [response codes](https://wiki.onap.org/).
22806       parameters:
22807         - name: named-query-uuid
22808           in: path
22809           required: true
22810           type: string
22811           example: __NAMED-QUERY-UUID__
22812         - name: named-query-element-uuid
22813           in: path
22814           required: true
22815           type: string
22816           example: __NAMED-QUERY-ELEMENT-UUID__
22817         - name: resource-version
22818           in: query
22819           description: resource-version for concurrency
22820           required: true
22821           type: string
22822   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
22823     get:
22824       tags:
22825         - ServiceDesignAndCreation
22826       summary: returns named-query-elements
22827       description: returns named-query-elements
22828       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
22829       produces:
22830         - application/json
22831         - application/xml
22832       responses:
22833         "200":
22834           description: successful operation
22835           schema:
22836               $ref: "#/getDefinitions/named-query-elements"
22837         "default":
22838           description: Response codes found in [response codes](https://wiki.onap.org/).
22839       parameters:
22840         - name: named-query-uuid
22841           in: path
22842           required: true
22843           type: string
22844           example: __NAMED-QUERY-UUID__
22845         - name: named-query-name
22846           in: query
22847           required: false
22848           type: string
22849   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
22850     put:
22851       tags:
22852         - ServiceDesignAndCreation
22853       summary: see node definition for valid relationships
22854       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
22855       consumes:
22856         - application/json
22857         - application/xml
22858       produces:
22859         - application/json
22860         - application/xml
22861       responses:
22862         "default":
22863           description: Response codes found in [response codes](https://wiki.onap.org/).
22864       parameters:
22865         - name: named-query-uuid
22866           in: path
22867           required: true
22868           type: string
22869           example: __NAMED-QUERY-UUID__
22870         - name: body
22871           in: body
22872           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
22873           required: true
22874           schema:
22875             $ref: "#/definitions/relationship"
22876     delete:
22877       tags:
22878         - ServiceDesignAndCreation
22879       summary: delete an existing relationship
22880       description: delete an existing relationship
22881       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
22882       consumes:
22883         - application/json
22884         - application/xml
22885       produces:
22886         - application/json
22887         - application/xml
22888       responses:
22889         "default":
22890           description: Response codes found in [response codes](https://wiki.onap.org/).
22891       parameters:
22892         - name: named-query-uuid
22893           in: path
22894           required: true
22895           type: string
22896           example: __NAMED-QUERY-UUID__
22897   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
22898     get:
22899       tags:
22900         - ServiceDesignAndCreation
22901       summary: returns named-query
22902       description: returns named-query
22903       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
22904       produces:
22905         - application/json
22906         - application/xml
22907       responses:
22908         "200":
22909           description: successful operation
22910           schema:
22911               $ref: "#/getDefinitions/named-query"
22912         "default":
22913           description: Response codes found in [response codes](https://wiki.onap.org/).
22914       parameters:
22915         - name: named-query-uuid
22916           in: path
22917           required: true
22918           type: string
22919           example: __NAMED-QUERY-UUID__
22920         - name: named-query-name
22921           in: query
22922           required: false
22923           type: string
22924     put:
22925       tags:
22926         - ServiceDesignAndCreation
22927       summary: create or update an existing named-query
22928       description: |
22929         Create or update an existing named-query.
22930         #
22931         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
22932       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
22933       consumes:
22934         - application/json
22935         - application/xml
22936       produces:
22937         - application/json
22938         - application/xml
22939       responses:
22940         "default":
22941           description: Response codes found in [response codes](https://wiki.onap.org/).
22942       parameters:
22943         - name: named-query-uuid
22944           in: path
22945           required: true
22946           type: string
22947           example: __NAMED-QUERY-UUID__
22948         - name: body
22949           in: body
22950           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
22951           required: true
22952           schema:
22953             $ref: "#/definitions/named-query"
22954     patch:
22955       tags:
22956         - ServiceDesignAndCreation
22957       summary: update an existing named-query
22958       description: |
22959         Update an existing named-query
22960         #
22961         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22962         The PUT operation will entirely replace an existing object.
22963         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.
22964         #
22965         Other differences between PUT and PATCH are:
22966         #
22967         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22968         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22969         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22970       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
22971       consumes:
22972         - application/json
22973         - application/xml
22974       produces:
22975         - application/json
22976         - application/xml
22977       responses:
22978         "default":
22979           description: Response codes found in [response codes](https://wiki.onap.org/).
22980       parameters:
22981         - name: named-query-uuid
22982           in: path
22983           required: true
22984           type: string
22985           example: __NAMED-QUERY-UUID__
22986         - name: body
22987           in: body
22988           description: named-query object that needs to be created or updated.
22989           required: true
22990           schema:
22991             $ref: "#/patchDefinitions/named-query"
22992     delete:
22993       tags:
22994         - ServiceDesignAndCreation
22995       summary: delete an existing named-query
22996       description: delete an existing named-query
22997       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
22998       consumes:
22999         - application/json
23000         - application/xml
23001       produces:
23002         - application/json
23003         - application/xml
23004       responses:
23005         "default":
23006           description: Response codes found in [response codes](https://wiki.onap.org/).
23007       parameters:
23008         - name: named-query-uuid
23009           in: path
23010           required: true
23011           type: string
23012           example: __NAMED-QUERY-UUID__
23013         - name: resource-version
23014           in: query
23015           description: resource-version for concurrency
23016           required: true
23017           type: string
23018   /service-design-and-creation/named-queries:
23019     get:
23020       tags:
23021         - ServiceDesignAndCreation
23022       summary: returns named-queries
23023       description: returns named-queries
23024       operationId: getServiceDesignAndCreationNamedQueries
23025       produces:
23026         - application/json
23027         - application/xml
23028       responses:
23029         "200":
23030           description: successful operation
23031           schema:
23032               $ref: "#/getDefinitions/named-queries"
23033         "default":
23034           description: Response codes found in [response codes](https://wiki.onap.org/).
23035   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
23036     put:
23037       tags:
23038         - Network
23039       summary: see node definition for valid relationships
23040       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
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: link-name
23052           in: path
23053           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23054           required: true
23055           type: string
23056           example: __LINK-NAME__
23057         - name: body
23058           in: body
23059           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
23060           required: true
23061           schema:
23062             $ref: "#/definitions/relationship"
23063     delete:
23064       tags:
23065         - Network
23066       summary: delete an existing relationship
23067       description: delete an existing relationship
23068       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
23069       consumes:
23070         - application/json
23071         - application/xml
23072       produces:
23073         - application/json
23074         - application/xml
23075       responses:
23076         "default":
23077           description: Response codes found in [response codes](https://wiki.onap.org/).
23078       parameters:
23079         - name: link-name
23080           in: path
23081           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23082           required: true
23083           type: string
23084           example: __LINK-NAME__
23085   /network/logical-links/logical-link/{link-name}:
23086     get:
23087       tags:
23088         - Network
23089       summary: returns logical-link
23090       description: returns logical-link
23091       operationId: getNetworkLogicalLinksLogicalLink
23092       produces:
23093         - application/json
23094         - application/xml
23095       responses:
23096         "200":
23097           description: successful operation
23098           schema:
23099               $ref: "#/getDefinitions/logical-link"
23100         "default":
23101           description: Response codes found in [response codes](https://wiki.onap.org/).
23102       parameters:
23103         - name: link-name
23104           in: path
23105           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23106           required: true
23107           type: string
23108           example: __LINK-NAME__
23109         - name: model-invariant-id
23110           in: query
23111           description: the ASDC model id for this resource or service model.
23112           required: false
23113           type: string
23114         - name: model-version-id
23115           in: query
23116           description: the ASDC model version for this resource or service model.
23117           required: false
23118           type: string
23119         - name: widget-model-id
23120           in: query
23121           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
23122           required: false
23123           type: string
23124         - name: widget-model-version
23125           in: query
23126           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
23127           required: false
23128           type: string
23129         - name: prov-status
23130           in: query
23131           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23132           required: false
23133           type: string
23134         - name: link-id
23135           in: query
23136           description: UUID of the logical-link, SDNC generates this.
23137           required: false
23138           type: string
23139         - name: circuit-id
23140           in: query
23141           description: Circuit id
23142           required: false
23143           type: string
23144         - name: purpose
23145           in: query
23146           description: Reason for this entity, role it is playing
23147           required: false
23148           type: string
23149     put:
23150       tags:
23151         - Network
23152       summary: create or update an existing logical-link
23153       description: |
23154         Create or update an existing logical-link.
23155         #
23156         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
23157       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
23158       consumes:
23159         - application/json
23160         - application/xml
23161       produces:
23162         - application/json
23163         - application/xml
23164       responses:
23165         "default":
23166           description: Response codes found in [response codes](https://wiki.onap.org/).
23167       parameters:
23168         - name: link-name
23169           in: path
23170           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23171           required: true
23172           type: string
23173           example: __LINK-NAME__
23174         - name: body
23175           in: body
23176           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
23177           required: true
23178           schema:
23179             $ref: "#/definitions/logical-link"
23180     patch:
23181       tags:
23182         - Network
23183       summary: update an existing logical-link
23184       description: |
23185         Update an existing logical-link
23186         #
23187         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23188         The PUT operation will entirely replace an existing object.
23189         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.
23190         #
23191         Other differences between PUT and PATCH are:
23192         #
23193         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23194         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23195         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23196       operationId: UpdateNetworkLogicalLinksLogicalLink
23197       consumes:
23198         - application/json
23199         - application/xml
23200       produces:
23201         - application/json
23202         - application/xml
23203       responses:
23204         "default":
23205           description: Response codes found in [response codes](https://wiki.onap.org/).
23206       parameters:
23207         - name: link-name
23208           in: path
23209           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23210           required: true
23211           type: string
23212           example: __LINK-NAME__
23213         - name: body
23214           in: body
23215           description: logical-link object that needs to be created or updated.
23216           required: true
23217           schema:
23218             $ref: "#/patchDefinitions/logical-link"
23219     delete:
23220       tags:
23221         - Network
23222       summary: delete an existing logical-link
23223       description: delete an existing logical-link
23224       operationId: deleteNetworkLogicalLinksLogicalLink
23225       consumes:
23226         - application/json
23227         - application/xml
23228       produces:
23229         - application/json
23230         - application/xml
23231       responses:
23232         "default":
23233           description: Response codes found in [response codes](https://wiki.onap.org/).
23234       parameters:
23235         - name: link-name
23236           in: path
23237           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
23238           required: true
23239           type: string
23240           example: __LINK-NAME__
23241         - name: resource-version
23242           in: query
23243           description: resource-version for concurrency
23244           required: true
23245           type: string
23246   /network/logical-links:
23247     get:
23248       tags:
23249         - Network
23250       summary: returns logical-links
23251       description: returns logical-links
23252       operationId: getNetworkLogicalLinks
23253       produces:
23254         - application/json
23255         - application/xml
23256       responses:
23257         "200":
23258           description: successful operation
23259           schema:
23260               $ref: "#/getDefinitions/logical-links"
23261         "default":
23262           description: Response codes found in [response codes](https://wiki.onap.org/).
23263   /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:
23264     put:
23265       tags:
23266         - Network
23267       summary: see node definition for valid relationships
23268       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
23269       consumes:
23270         - application/json
23271         - application/xml
23272       produces:
23273         - application/json
23274         - application/xml
23275       responses:
23276         "default":
23277           description: Response codes found in [response codes](https://wiki.onap.org/).
23278       parameters:
23279         - name: site-pair-set-id
23280           in: path
23281           description: Unique id of site pair set.
23282           required: true
23283           type: string
23284           example: __SITE-PAIR-SET-ID__
23285         - name: routing-instance-id
23286           in: path
23287           description: Unique id of routing instance
23288           required: true
23289           type: string
23290           example: __ROUTING-INSTANCE-ID__
23291         - name: site-pair-id
23292           in: path
23293           description: unique identifier of probe
23294           required: true
23295           type: string
23296           example: __SITE-PAIR-ID__
23297         - name: cos
23298           in: path
23299           description: unique identifier of probe
23300           required: true
23301           type: string
23302           example: __COS__
23303         - name: body
23304           in: body
23305           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
23306           required: true
23307           schema:
23308             $ref: "#/definitions/relationship"
23309     delete:
23310       tags:
23311         - Network
23312       summary: delete an existing relationship
23313       description: delete an existing relationship
23314       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
23315       consumes:
23316         - application/json
23317         - application/xml
23318       produces:
23319         - application/json
23320         - application/xml
23321       responses:
23322         "default":
23323           description: Response codes found in [response codes](https://wiki.onap.org/).
23324       parameters:
23325         - name: site-pair-set-id
23326           in: path
23327           description: Unique id of site pair set.
23328           required: true
23329           type: string
23330           example: __SITE-PAIR-SET-ID__
23331         - name: routing-instance-id
23332           in: path
23333           description: Unique id of routing instance
23334           required: true
23335           type: string
23336           example: __ROUTING-INSTANCE-ID__
23337         - name: site-pair-id
23338           in: path
23339           description: unique identifier of probe
23340           required: true
23341           type: string
23342           example: __SITE-PAIR-ID__
23343         - name: cos
23344           in: path
23345           description: unique identifier of probe
23346           required: true
23347           type: string
23348           example: __COS__
23349   /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}:
23350     get:
23351       tags:
23352         - Network
23353       summary: returns class-of-service
23354       description: returns class-of-service
23355       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23356       produces:
23357         - application/json
23358         - application/xml
23359       responses:
23360         "200":
23361           description: successful operation
23362           schema:
23363               $ref: "#/getDefinitions/class-of-service"
23364         "default":
23365           description: Response codes found in [response codes](https://wiki.onap.org/).
23366       parameters:
23367         - name: site-pair-set-id
23368           in: path
23369           description: Unique id of site pair set.
23370           required: true
23371           type: string
23372           example: __SITE-PAIR-SET-ID__
23373         - name: routing-instance-id
23374           in: path
23375           description: Unique id of routing instance
23376           required: true
23377           type: string
23378           example: __ROUTING-INSTANCE-ID__
23379         - name: site-pair-id
23380           in: path
23381           description: unique identifier of probe
23382           required: true
23383           type: string
23384           example: __SITE-PAIR-ID__
23385         - name: cos
23386           in: path
23387           description: unique identifier of probe
23388           required: true
23389           type: string
23390           example: __COS__
23391     put:
23392       tags:
23393         - Network
23394       summary: create or update an existing class-of-service
23395       description: |
23396         Create or update an existing class-of-service.
23397         #
23398         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
23399       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23400       consumes:
23401         - application/json
23402         - application/xml
23403       produces:
23404         - application/json
23405         - application/xml
23406       responses:
23407         "default":
23408           description: Response codes found in [response codes](https://wiki.onap.org/).
23409       parameters:
23410         - name: site-pair-set-id
23411           in: path
23412           description: Unique id of site pair set.
23413           required: true
23414           type: string
23415           example: __SITE-PAIR-SET-ID__
23416         - name: routing-instance-id
23417           in: path
23418           description: Unique id of routing instance
23419           required: true
23420           type: string
23421           example: __ROUTING-INSTANCE-ID__
23422         - name: site-pair-id
23423           in: path
23424           description: unique identifier of probe
23425           required: true
23426           type: string
23427           example: __SITE-PAIR-ID__
23428         - name: cos
23429           in: path
23430           description: unique identifier of probe
23431           required: true
23432           type: string
23433           example: __COS__
23434         - name: body
23435           in: body
23436           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
23437           required: true
23438           schema:
23439             $ref: "#/definitions/class-of-service"
23440     patch:
23441       tags:
23442         - Network
23443       summary: update an existing class-of-service
23444       description: |
23445         Update an existing class-of-service
23446         #
23447         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23448         The PUT operation will entirely replace an existing object.
23449         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.
23450         #
23451         Other differences between PUT and PATCH are:
23452         #
23453         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23454         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23455         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23456       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23457       consumes:
23458         - application/json
23459         - application/xml
23460       produces:
23461         - application/json
23462         - application/xml
23463       responses:
23464         "default":
23465           description: Response codes found in [response codes](https://wiki.onap.org/).
23466       parameters:
23467         - name: site-pair-set-id
23468           in: path
23469           description: Unique id of site pair set.
23470           required: true
23471           type: string
23472           example: __SITE-PAIR-SET-ID__
23473         - name: routing-instance-id
23474           in: path
23475           description: Unique id of routing instance
23476           required: true
23477           type: string
23478           example: __ROUTING-INSTANCE-ID__
23479         - name: site-pair-id
23480           in: path
23481           description: unique identifier of probe
23482           required: true
23483           type: string
23484           example: __SITE-PAIR-ID__
23485         - name: cos
23486           in: path
23487           description: unique identifier of probe
23488           required: true
23489           type: string
23490           example: __COS__
23491         - name: body
23492           in: body
23493           description: class-of-service object that needs to be created or updated.
23494           required: true
23495           schema:
23496             $ref: "#/patchDefinitions/class-of-service"
23497     delete:
23498       tags:
23499         - Network
23500       summary: delete an existing class-of-service
23501       description: delete an existing class-of-service
23502       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
23503       consumes:
23504         - application/json
23505         - application/xml
23506       produces:
23507         - application/json
23508         - application/xml
23509       responses:
23510         "default":
23511           description: Response codes found in [response codes](https://wiki.onap.org/).
23512       parameters:
23513         - name: site-pair-set-id
23514           in: path
23515           description: Unique id of site pair set.
23516           required: true
23517           type: string
23518           example: __SITE-PAIR-SET-ID__
23519         - name: routing-instance-id
23520           in: path
23521           description: Unique id of routing instance
23522           required: true
23523           type: string
23524           example: __ROUTING-INSTANCE-ID__
23525         - name: site-pair-id
23526           in: path
23527           description: unique identifier of probe
23528           required: true
23529           type: string
23530           example: __SITE-PAIR-ID__
23531         - name: cos
23532           in: path
23533           description: unique identifier of probe
23534           required: true
23535           type: string
23536           example: __COS__
23537         - name: resource-version
23538           in: query
23539           description: resource-version for concurrency
23540           required: true
23541           type: string
23542   /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:
23543     get:
23544       tags:
23545         - Network
23546       summary: returns classes-of-service
23547       description: returns classes-of-service
23548       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
23549       produces:
23550         - application/json
23551         - application/xml
23552       responses:
23553         "200":
23554           description: successful operation
23555           schema:
23556               $ref: "#/getDefinitions/classes-of-service"
23557         "default":
23558           description: Response codes found in [response codes](https://wiki.onap.org/).
23559       parameters:
23560         - name: site-pair-set-id
23561           in: path
23562           description: Unique id of site pair set.
23563           required: true
23564           type: string
23565           example: __SITE-PAIR-SET-ID__
23566         - name: routing-instance-id
23567           in: path
23568           description: Unique id of routing instance
23569           required: true
23570           type: string
23571           example: __ROUTING-INSTANCE-ID__
23572         - name: site-pair-id
23573           in: path
23574           description: unique identifier of probe
23575           required: true
23576           type: string
23577           example: __SITE-PAIR-ID__
23578   /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:
23579     put:
23580       tags:
23581         - Network
23582       summary: see node definition for valid relationships
23583       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
23584       consumes:
23585         - application/json
23586         - application/xml
23587       produces:
23588         - application/json
23589         - application/xml
23590       responses:
23591         "default":
23592           description: Response codes found in [response codes](https://wiki.onap.org/).
23593       parameters:
23594         - name: site-pair-set-id
23595           in: path
23596           description: Unique id of site pair set.
23597           required: true
23598           type: string
23599           example: __SITE-PAIR-SET-ID__
23600         - name: routing-instance-id
23601           in: path
23602           description: Unique id of routing instance
23603           required: true
23604           type: string
23605           example: __ROUTING-INSTANCE-ID__
23606         - name: site-pair-id
23607           in: path
23608           description: unique identifier of probe
23609           required: true
23610           type: string
23611           example: __SITE-PAIR-ID__
23612         - name: body
23613           in: body
23614           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
23615           required: true
23616           schema:
23617             $ref: "#/definitions/relationship"
23618     delete:
23619       tags:
23620         - Network
23621       summary: delete an existing relationship
23622       description: delete an existing relationship
23623       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
23624       consumes:
23625         - application/json
23626         - application/xml
23627       produces:
23628         - application/json
23629         - application/xml
23630       responses:
23631         "default":
23632           description: Response codes found in [response codes](https://wiki.onap.org/).
23633       parameters:
23634         - name: site-pair-set-id
23635           in: path
23636           description: Unique id of site pair set.
23637           required: true
23638           type: string
23639           example: __SITE-PAIR-SET-ID__
23640         - name: routing-instance-id
23641           in: path
23642           description: Unique id of routing instance
23643           required: true
23644           type: string
23645           example: __ROUTING-INSTANCE-ID__
23646         - name: site-pair-id
23647           in: path
23648           description: unique identifier of probe
23649           required: true
23650           type: string
23651           example: __SITE-PAIR-ID__
23652   /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}:
23653     get:
23654       tags:
23655         - Network
23656       summary: returns site-pair
23657       description: returns site-pair
23658       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
23659       produces:
23660         - application/json
23661         - application/xml
23662       responses:
23663         "200":
23664           description: successful operation
23665           schema:
23666               $ref: "#/getDefinitions/site-pair"
23667         "default":
23668           description: Response codes found in [response codes](https://wiki.onap.org/).
23669       parameters:
23670         - name: site-pair-set-id
23671           in: path
23672           description: Unique id of site pair set.
23673           required: true
23674           type: string
23675           example: __SITE-PAIR-SET-ID__
23676         - name: routing-instance-id
23677           in: path
23678           description: Unique id of routing instance
23679           required: true
23680           type: string
23681           example: __ROUTING-INSTANCE-ID__
23682         - name: site-pair-id
23683           in: path
23684           description: unique identifier of probe
23685           required: true
23686           type: string
23687           example: __SITE-PAIR-ID__
23688     put:
23689       tags:
23690         - Network
23691       summary: create or update an existing site-pair
23692       description: |
23693         Create or update an existing site-pair.
23694         #
23695         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
23696       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
23697       consumes:
23698         - application/json
23699         - application/xml
23700       produces:
23701         - application/json
23702         - application/xml
23703       responses:
23704         "default":
23705           description: Response codes found in [response codes](https://wiki.onap.org/).
23706       parameters:
23707         - name: site-pair-set-id
23708           in: path
23709           description: Unique id of site pair set.
23710           required: true
23711           type: string
23712           example: __SITE-PAIR-SET-ID__
23713         - name: routing-instance-id
23714           in: path
23715           description: Unique id of routing instance
23716           required: true
23717           type: string
23718           example: __ROUTING-INSTANCE-ID__
23719         - name: site-pair-id
23720           in: path
23721           description: unique identifier of probe
23722           required: true
23723           type: string
23724           example: __SITE-PAIR-ID__
23725         - name: body
23726           in: body
23727           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
23728           required: true
23729           schema:
23730             $ref: "#/definitions/site-pair"
23731     patch:
23732       tags:
23733         - Network
23734       summary: update an existing site-pair
23735       description: |
23736         Update an existing site-pair
23737         #
23738         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23739         The PUT operation will entirely replace an existing object.
23740         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.
23741         #
23742         Other differences between PUT and PATCH are:
23743         #
23744         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23745         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23746         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23747       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
23748       consumes:
23749         - application/json
23750         - application/xml
23751       produces:
23752         - application/json
23753         - application/xml
23754       responses:
23755         "default":
23756           description: Response codes found in [response codes](https://wiki.onap.org/).
23757       parameters:
23758         - name: site-pair-set-id
23759           in: path
23760           description: Unique id of site pair set.
23761           required: true
23762           type: string
23763           example: __SITE-PAIR-SET-ID__
23764         - name: routing-instance-id
23765           in: path
23766           description: Unique id of routing instance
23767           required: true
23768           type: string
23769           example: __ROUTING-INSTANCE-ID__
23770         - name: site-pair-id
23771           in: path
23772           description: unique identifier of probe
23773           required: true
23774           type: string
23775           example: __SITE-PAIR-ID__
23776         - name: body
23777           in: body
23778           description: site-pair object that needs to be created or updated.
23779           required: true
23780           schema:
23781             $ref: "#/patchDefinitions/site-pair"
23782     delete:
23783       tags:
23784         - Network
23785       summary: delete an existing site-pair
23786       description: delete an existing site-pair
23787       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
23788       consumes:
23789         - application/json
23790         - application/xml
23791       produces:
23792         - application/json
23793         - application/xml
23794       responses:
23795         "default":
23796           description: Response codes found in [response codes](https://wiki.onap.org/).
23797       parameters:
23798         - name: site-pair-set-id
23799           in: path
23800           description: Unique id of site pair set.
23801           required: true
23802           type: string
23803           example: __SITE-PAIR-SET-ID__
23804         - name: routing-instance-id
23805           in: path
23806           description: Unique id of routing instance
23807           required: true
23808           type: string
23809           example: __ROUTING-INSTANCE-ID__
23810         - name: site-pair-id
23811           in: path
23812           description: unique identifier of probe
23813           required: true
23814           type: string
23815           example: __SITE-PAIR-ID__
23816         - name: resource-version
23817           in: query
23818           description: resource-version for concurrency
23819           required: true
23820           type: string
23821   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
23822     get:
23823       tags:
23824         - Network
23825       summary: returns site-pairs
23826       description: returns site-pairs
23827       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
23828       produces:
23829         - application/json
23830         - application/xml
23831       responses:
23832         "200":
23833           description: successful operation
23834           schema:
23835               $ref: "#/getDefinitions/site-pairs"
23836         "default":
23837           description: Response codes found in [response codes](https://wiki.onap.org/).
23838       parameters:
23839         - name: site-pair-set-id
23840           in: path
23841           description: Unique id of site pair set.
23842           required: true
23843           type: string
23844           example: __SITE-PAIR-SET-ID__
23845         - name: routing-instance-id
23846           in: path
23847           description: Unique id of routing instance
23848           required: true
23849           type: string
23850           example: __ROUTING-INSTANCE-ID__
23851   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
23852     put:
23853       tags:
23854         - Network
23855       summary: see node definition for valid relationships
23856       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
23857       consumes:
23858         - application/json
23859         - application/xml
23860       produces:
23861         - application/json
23862         - application/xml
23863       responses:
23864         "default":
23865           description: Response codes found in [response codes](https://wiki.onap.org/).
23866       parameters:
23867         - name: site-pair-set-id
23868           in: path
23869           description: Unique id of site pair set.
23870           required: true
23871           type: string
23872           example: __SITE-PAIR-SET-ID__
23873         - name: routing-instance-id
23874           in: path
23875           description: Unique id of routing instance
23876           required: true
23877           type: string
23878           example: __ROUTING-INSTANCE-ID__
23879         - name: body
23880           in: body
23881           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23882           required: true
23883           schema:
23884             $ref: "#/definitions/relationship"
23885     delete:
23886       tags:
23887         - Network
23888       summary: delete an existing relationship
23889       description: delete an existing relationship
23890       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
23891       consumes:
23892         - application/json
23893         - application/xml
23894       produces:
23895         - application/json
23896         - application/xml
23897       responses:
23898         "default":
23899           description: Response codes found in [response codes](https://wiki.onap.org/).
23900       parameters:
23901         - name: site-pair-set-id
23902           in: path
23903           description: Unique id of site pair set.
23904           required: true
23905           type: string
23906           example: __SITE-PAIR-SET-ID__
23907         - name: routing-instance-id
23908           in: path
23909           description: Unique id of routing instance
23910           required: true
23911           type: string
23912           example: __ROUTING-INSTANCE-ID__
23913   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
23914     get:
23915       tags:
23916         - Network
23917       summary: returns routing-instance
23918       description: returns routing-instance
23919       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23920       produces:
23921         - application/json
23922         - application/xml
23923       responses:
23924         "200":
23925           description: successful operation
23926           schema:
23927               $ref: "#/getDefinitions/routing-instance"
23928         "default":
23929           description: Response codes found in [response codes](https://wiki.onap.org/).
23930       parameters:
23931         - name: site-pair-set-id
23932           in: path
23933           description: Unique id of site pair set.
23934           required: true
23935           type: string
23936           example: __SITE-PAIR-SET-ID__
23937         - name: routing-instance-id
23938           in: path
23939           description: Unique id of routing instance
23940           required: true
23941           type: string
23942           example: __ROUTING-INSTANCE-ID__
23943     put:
23944       tags:
23945         - Network
23946       summary: create or update an existing routing-instance
23947       description: |
23948         Create or update an existing routing-instance.
23949         #
23950         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
23951       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23952       consumes:
23953         - application/json
23954         - application/xml
23955       produces:
23956         - application/json
23957         - application/xml
23958       responses:
23959         "default":
23960           description: Response codes found in [response codes](https://wiki.onap.org/).
23961       parameters:
23962         - name: site-pair-set-id
23963           in: path
23964           description: Unique id of site pair set.
23965           required: true
23966           type: string
23967           example: __SITE-PAIR-SET-ID__
23968         - name: routing-instance-id
23969           in: path
23970           description: Unique id of routing instance
23971           required: true
23972           type: string
23973           example: __ROUTING-INSTANCE-ID__
23974         - name: body
23975           in: body
23976           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23977           required: true
23978           schema:
23979             $ref: "#/definitions/routing-instance"
23980     patch:
23981       tags:
23982         - Network
23983       summary: update an existing routing-instance
23984       description: |
23985         Update an existing routing-instance
23986         #
23987         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23988         The PUT operation will entirely replace an existing object.
23989         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.
23990         #
23991         Other differences between PUT and PATCH are:
23992         #
23993         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23994         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23995         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23996       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23997       consumes:
23998         - application/json
23999         - application/xml
24000       produces:
24001         - application/json
24002         - application/xml
24003       responses:
24004         "default":
24005           description: Response codes found in [response codes](https://wiki.onap.org/).
24006       parameters:
24007         - name: site-pair-set-id
24008           in: path
24009           description: Unique id of site pair set.
24010           required: true
24011           type: string
24012           example: __SITE-PAIR-SET-ID__
24013         - name: routing-instance-id
24014           in: path
24015           description: Unique id of routing instance
24016           required: true
24017           type: string
24018           example: __ROUTING-INSTANCE-ID__
24019         - name: body
24020           in: body
24021           description: routing-instance object that needs to be created or updated.
24022           required: true
24023           schema:
24024             $ref: "#/patchDefinitions/routing-instance"
24025     delete:
24026       tags:
24027         - Network
24028       summary: delete an existing routing-instance
24029       description: delete an existing routing-instance
24030       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
24031       consumes:
24032         - application/json
24033         - application/xml
24034       produces:
24035         - application/json
24036         - application/xml
24037       responses:
24038         "default":
24039           description: Response codes found in [response codes](https://wiki.onap.org/).
24040       parameters:
24041         - name: site-pair-set-id
24042           in: path
24043           description: Unique id of site pair set.
24044           required: true
24045           type: string
24046           example: __SITE-PAIR-SET-ID__
24047         - name: routing-instance-id
24048           in: path
24049           description: Unique id of routing instance
24050           required: true
24051           type: string
24052           example: __ROUTING-INSTANCE-ID__
24053         - name: resource-version
24054           in: query
24055           description: resource-version for concurrency
24056           required: true
24057           type: string
24058   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
24059     get:
24060       tags:
24061         - Network
24062       summary: returns routing-instances
24063       description: returns routing-instances
24064       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
24065       produces:
24066         - application/json
24067         - application/xml
24068       responses:
24069         "200":
24070           description: successful operation
24071           schema:
24072               $ref: "#/getDefinitions/routing-instances"
24073         "default":
24074           description: Response codes found in [response codes](https://wiki.onap.org/).
24075       parameters:
24076         - name: site-pair-set-id
24077           in: path
24078           description: Unique id of site pair set.
24079           required: true
24080           type: string
24081           example: __SITE-PAIR-SET-ID__
24082   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
24083     put:
24084       tags:
24085         - Network
24086       summary: see node definition for valid relationships
24087       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
24088       consumes:
24089         - application/json
24090         - application/xml
24091       produces:
24092         - application/json
24093         - application/xml
24094       responses:
24095         "default":
24096           description: Response codes found in [response codes](https://wiki.onap.org/).
24097       parameters:
24098         - name: site-pair-set-id
24099           in: path
24100           description: Unique id of site pair set.
24101           required: true
24102           type: string
24103           example: __SITE-PAIR-SET-ID__
24104         - name: body
24105           in: body
24106           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
24107           required: true
24108           schema:
24109             $ref: "#/definitions/relationship"
24110     delete:
24111       tags:
24112         - Network
24113       summary: delete an existing relationship
24114       description: delete an existing relationship
24115       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
24116       consumes:
24117         - application/json
24118         - application/xml
24119       produces:
24120         - application/json
24121         - application/xml
24122       responses:
24123         "default":
24124           description: Response codes found in [response codes](https://wiki.onap.org/).
24125       parameters:
24126         - name: site-pair-set-id
24127           in: path
24128           description: Unique id of site pair set.
24129           required: true
24130           type: string
24131           example: __SITE-PAIR-SET-ID__
24132   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
24133     get:
24134       tags:
24135         - Network
24136       summary: returns site-pair-set
24137       description: returns site-pair-set
24138       operationId: getNetworkSitePairSetsSitePairSet
24139       produces:
24140         - application/json
24141         - application/xml
24142       responses:
24143         "200":
24144           description: successful operation
24145           schema:
24146               $ref: "#/getDefinitions/site-pair-set"
24147         "default":
24148           description: Response codes found in [response codes](https://wiki.onap.org/).
24149       parameters:
24150         - name: site-pair-set-id
24151           in: path
24152           description: Unique id of site pair set.
24153           required: true
24154           type: string
24155           example: __SITE-PAIR-SET-ID__
24156     put:
24157       tags:
24158         - Network
24159       summary: create or update an existing site-pair-set
24160       description: |
24161         Create or update an existing site-pair-set.
24162         #
24163         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
24164       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
24165       consumes:
24166         - application/json
24167         - application/xml
24168       produces:
24169         - application/json
24170         - application/xml
24171       responses:
24172         "default":
24173           description: Response codes found in [response codes](https://wiki.onap.org/).
24174       parameters:
24175         - name: site-pair-set-id
24176           in: path
24177           description: Unique id of site pair set.
24178           required: true
24179           type: string
24180           example: __SITE-PAIR-SET-ID__
24181         - name: body
24182           in: body
24183           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
24184           required: true
24185           schema:
24186             $ref: "#/definitions/site-pair-set"
24187     patch:
24188       tags:
24189         - Network
24190       summary: update an existing site-pair-set
24191       description: |
24192         Update an existing site-pair-set
24193         #
24194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24195         The PUT operation will entirely replace an existing object.
24196         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.
24197         #
24198         Other differences between PUT and PATCH are:
24199         #
24200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24203       operationId: UpdateNetworkSitePairSetsSitePairSet
24204       consumes:
24205         - application/json
24206         - application/xml
24207       produces:
24208         - application/json
24209         - application/xml
24210       responses:
24211         "default":
24212           description: Response codes found in [response codes](https://wiki.onap.org/).
24213       parameters:
24214         - name: site-pair-set-id
24215           in: path
24216           description: Unique id of site pair set.
24217           required: true
24218           type: string
24219           example: __SITE-PAIR-SET-ID__
24220         - name: body
24221           in: body
24222           description: site-pair-set object that needs to be created or updated.
24223           required: true
24224           schema:
24225             $ref: "#/patchDefinitions/site-pair-set"
24226     delete:
24227       tags:
24228         - Network
24229       summary: delete an existing site-pair-set
24230       description: delete an existing site-pair-set
24231       operationId: deleteNetworkSitePairSetsSitePairSet
24232       consumes:
24233         - application/json
24234         - application/xml
24235       produces:
24236         - application/json
24237         - application/xml
24238       responses:
24239         "default":
24240           description: Response codes found in [response codes](https://wiki.onap.org/).
24241       parameters:
24242         - name: site-pair-set-id
24243           in: path
24244           description: Unique id of site pair set.
24245           required: true
24246           type: string
24247           example: __SITE-PAIR-SET-ID__
24248         - name: resource-version
24249           in: query
24250           description: resource-version for concurrency
24251           required: true
24252           type: string
24253   /network/site-pair-sets:
24254     get:
24255       tags:
24256         - Network
24257       summary: returns site-pair-sets
24258       description: returns site-pair-sets
24259       operationId: getNetworkSitePairSets
24260       produces:
24261         - application/json
24262         - application/xml
24263       responses:
24264         "200":
24265           description: successful operation
24266           schema:
24267               $ref: "#/getDefinitions/site-pair-sets"
24268         "default":
24269           description: Response codes found in [response codes](https://wiki.onap.org/).
24270   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
24271     put:
24272       tags:
24273         - Network
24274       summary: see node definition for valid relationships
24275       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
24276       consumes:
24277         - application/json
24278         - application/xml
24279       produces:
24280         - application/json
24281         - application/xml
24282       responses:
24283         "default":
24284           description: Response codes found in [response codes](https://wiki.onap.org/).
24285       parameters:
24286         - name: vpn-id
24287           in: path
24288           description: VPN ID, globally unique within A&AI
24289           required: true
24290           type: string
24291           example: __VPN-ID__
24292         - name: global-route-target
24293           in: path
24294           description: Number used to identify an RT, globally unique in the network
24295           required: true
24296           type: string
24297           example: __GLOBAL-ROUTE-TARGET__
24298         - name: route-target-role
24299           in: path
24300           description: Role assigned to this route target
24301           required: true
24302           type: string
24303           example: __ROUTE-TARGET-ROLE__
24304         - name: body
24305           in: body
24306           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
24307           required: true
24308           schema:
24309             $ref: "#/definitions/relationship"
24310     delete:
24311       tags:
24312         - Network
24313       summary: delete an existing relationship
24314       description: delete an existing relationship
24315       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
24316       consumes:
24317         - application/json
24318         - application/xml
24319       produces:
24320         - application/json
24321         - application/xml
24322       responses:
24323         "default":
24324           description: Response codes found in [response codes](https://wiki.onap.org/).
24325       parameters:
24326         - name: vpn-id
24327           in: path
24328           description: VPN ID, globally unique within A&AI
24329           required: true
24330           type: string
24331           example: __VPN-ID__
24332         - name: global-route-target
24333           in: path
24334           description: Number used to identify an RT, globally unique in the network
24335           required: true
24336           type: string
24337           example: __GLOBAL-ROUTE-TARGET__
24338         - name: route-target-role
24339           in: path
24340           description: Role assigned to this route target
24341           required: true
24342           type: string
24343           example: __ROUTE-TARGET-ROLE__
24344   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
24345     get:
24346       tags:
24347         - Network
24348       summary: returns route-target
24349       description: returns route-target
24350       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24351       produces:
24352         - application/json
24353         - application/xml
24354       responses:
24355         "200":
24356           description: successful operation
24357           schema:
24358               $ref: "#/getDefinitions/route-target"
24359         "default":
24360           description: Response codes found in [response codes](https://wiki.onap.org/).
24361       parameters:
24362         - name: vpn-id
24363           in: path
24364           description: VPN ID, globally unique within A&AI
24365           required: true
24366           type: string
24367           example: __VPN-ID__
24368         - name: global-route-target
24369           in: path
24370           description: Number used to identify an RT, globally unique in the network
24371           required: true
24372           type: string
24373           example: __GLOBAL-ROUTE-TARGET__
24374         - name: route-target-role
24375           in: path
24376           description: Role assigned to this route target
24377           required: true
24378           type: string
24379           example: __ROUTE-TARGET-ROLE__
24380         - name: vpn-name
24381           in: query
24382           description: VPN Name
24383           required: false
24384           type: string
24385         - name: vpn-type
24386           in: query
24387           description: Type of the vpn, should be taken from enumerated/valid values
24388           required: false
24389           type: string
24390     put:
24391       tags:
24392         - Network
24393       summary: create or update an existing route-target
24394       description: |
24395         Create or update an existing route-target.
24396         #
24397         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
24398       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24399       consumes:
24400         - application/json
24401         - application/xml
24402       produces:
24403         - application/json
24404         - application/xml
24405       responses:
24406         "default":
24407           description: Response codes found in [response codes](https://wiki.onap.org/).
24408       parameters:
24409         - name: vpn-id
24410           in: path
24411           description: VPN ID, globally unique within A&AI
24412           required: true
24413           type: string
24414           example: __VPN-ID__
24415         - name: global-route-target
24416           in: path
24417           description: Number used to identify an RT, globally unique in the network
24418           required: true
24419           type: string
24420           example: __GLOBAL-ROUTE-TARGET__
24421         - name: route-target-role
24422           in: path
24423           description: Role assigned to this route target
24424           required: true
24425           type: string
24426           example: __ROUTE-TARGET-ROLE__
24427         - name: body
24428           in: body
24429           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
24430           required: true
24431           schema:
24432             $ref: "#/definitions/route-target"
24433     patch:
24434       tags:
24435         - Network
24436       summary: update an existing route-target
24437       description: |
24438         Update an existing route-target
24439         #
24440         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24441         The PUT operation will entirely replace an existing object.
24442         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.
24443         #
24444         Other differences between PUT and PATCH are:
24445         #
24446         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24447         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24448         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24449       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24450       consumes:
24451         - application/json
24452         - application/xml
24453       produces:
24454         - application/json
24455         - application/xml
24456       responses:
24457         "default":
24458           description: Response codes found in [response codes](https://wiki.onap.org/).
24459       parameters:
24460         - name: vpn-id
24461           in: path
24462           description: VPN ID, globally unique within A&AI
24463           required: true
24464           type: string
24465           example: __VPN-ID__
24466         - name: global-route-target
24467           in: path
24468           description: Number used to identify an RT, globally unique in the network
24469           required: true
24470           type: string
24471           example: __GLOBAL-ROUTE-TARGET__
24472         - name: route-target-role
24473           in: path
24474           description: Role assigned to this route target
24475           required: true
24476           type: string
24477           example: __ROUTE-TARGET-ROLE__
24478         - name: body
24479           in: body
24480           description: route-target object that needs to be created or updated.
24481           required: true
24482           schema:
24483             $ref: "#/patchDefinitions/route-target"
24484     delete:
24485       tags:
24486         - Network
24487       summary: delete an existing route-target
24488       description: delete an existing route-target
24489       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
24490       consumes:
24491         - application/json
24492         - application/xml
24493       produces:
24494         - application/json
24495         - application/xml
24496       responses:
24497         "default":
24498           description: Response codes found in [response codes](https://wiki.onap.org/).
24499       parameters:
24500         - name: vpn-id
24501           in: path
24502           description: VPN ID, globally unique within A&AI
24503           required: true
24504           type: string
24505           example: __VPN-ID__
24506         - name: global-route-target
24507           in: path
24508           description: Number used to identify an RT, globally unique in the network
24509           required: true
24510           type: string
24511           example: __GLOBAL-ROUTE-TARGET__
24512         - name: route-target-role
24513           in: path
24514           description: Role assigned to this route target
24515           required: true
24516           type: string
24517           example: __ROUTE-TARGET-ROLE__
24518         - name: resource-version
24519           in: query
24520           description: resource-version for concurrency
24521           required: true
24522           type: string
24523   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
24524     get:
24525       tags:
24526         - Network
24527       summary: returns route-targets
24528       description: returns route-targets
24529       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
24530       produces:
24531         - application/json
24532         - application/xml
24533       responses:
24534         "200":
24535           description: successful operation
24536           schema:
24537               $ref: "#/getDefinitions/route-targets"
24538         "default":
24539           description: Response codes found in [response codes](https://wiki.onap.org/).
24540       parameters:
24541         - name: vpn-id
24542           in: path
24543           description: VPN ID, globally unique within A&AI
24544           required: true
24545           type: string
24546           example: __VPN-ID__
24547         - name: vpn-name
24548           in: query
24549           description: VPN Name
24550           required: false
24551           type: string
24552         - name: vpn-type
24553           in: query
24554           description: Type of the vpn, should be taken from enumerated/valid values
24555           required: false
24556           type: string
24557   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
24558     put:
24559       tags:
24560         - Network
24561       summary: see node definition for valid relationships
24562       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
24563       consumes:
24564         - application/json
24565         - application/xml
24566       produces:
24567         - application/json
24568         - application/xml
24569       responses:
24570         "default":
24571           description: Response codes found in [response codes](https://wiki.onap.org/).
24572       parameters:
24573         - name: vpn-id
24574           in: path
24575           description: VPN ID, globally unique within A&AI
24576           required: true
24577           type: string
24578           example: __VPN-ID__
24579         - name: body
24580           in: body
24581           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
24582           required: true
24583           schema:
24584             $ref: "#/definitions/relationship"
24585     delete:
24586       tags:
24587         - Network
24588       summary: delete an existing relationship
24589       description: delete an existing relationship
24590       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
24591       consumes:
24592         - application/json
24593         - application/xml
24594       produces:
24595         - application/json
24596         - application/xml
24597       responses:
24598         "default":
24599           description: Response codes found in [response codes](https://wiki.onap.org/).
24600       parameters:
24601         - name: vpn-id
24602           in: path
24603           description: VPN ID, globally unique within A&AI
24604           required: true
24605           type: string
24606           example: __VPN-ID__
24607   /network/vpn-bindings/vpn-binding/{vpn-id}:
24608     get:
24609       tags:
24610         - Network
24611       summary: returns vpn-binding
24612       description: returns vpn-binding
24613       operationId: getNetworkVpnBindingsVpnBinding
24614       produces:
24615         - application/json
24616         - application/xml
24617       responses:
24618         "200":
24619           description: successful operation
24620           schema:
24621               $ref: "#/getDefinitions/vpn-binding"
24622         "default":
24623           description: Response codes found in [response codes](https://wiki.onap.org/).
24624       parameters:
24625         - name: vpn-id
24626           in: path
24627           description: VPN ID, globally unique within A&AI
24628           required: true
24629           type: string
24630           example: __VPN-ID__
24631         - name: vpn-name
24632           in: query
24633           description: VPN Name
24634           required: false
24635           type: string
24636         - name: vpn-type
24637           in: query
24638           description: Type of the vpn, should be taken from enumerated/valid values
24639           required: false
24640           type: string
24641     put:
24642       tags:
24643         - Network
24644       summary: create or update an existing vpn-binding
24645       description: |
24646         Create or update an existing vpn-binding.
24647         #
24648         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
24649       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
24650       consumes:
24651         - application/json
24652         - application/xml
24653       produces:
24654         - application/json
24655         - application/xml
24656       responses:
24657         "default":
24658           description: Response codes found in [response codes](https://wiki.onap.org/).
24659       parameters:
24660         - name: vpn-id
24661           in: path
24662           description: VPN ID, globally unique within A&AI
24663           required: true
24664           type: string
24665           example: __VPN-ID__
24666         - name: body
24667           in: body
24668           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
24669           required: true
24670           schema:
24671             $ref: "#/definitions/vpn-binding"
24672     patch:
24673       tags:
24674         - Network
24675       summary: update an existing vpn-binding
24676       description: |
24677         Update an existing vpn-binding
24678         #
24679         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24680         The PUT operation will entirely replace an existing object.
24681         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.
24682         #
24683         Other differences between PUT and PATCH are:
24684         #
24685         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24686         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24687         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24688       operationId: UpdateNetworkVpnBindingsVpnBinding
24689       consumes:
24690         - application/json
24691         - application/xml
24692       produces:
24693         - application/json
24694         - application/xml
24695       responses:
24696         "default":
24697           description: Response codes found in [response codes](https://wiki.onap.org/).
24698       parameters:
24699         - name: vpn-id
24700           in: path
24701           description: VPN ID, globally unique within A&AI
24702           required: true
24703           type: string
24704           example: __VPN-ID__
24705         - name: body
24706           in: body
24707           description: vpn-binding object that needs to be created or updated.
24708           required: true
24709           schema:
24710             $ref: "#/patchDefinitions/vpn-binding"
24711     delete:
24712       tags:
24713         - Network
24714       summary: delete an existing vpn-binding
24715       description: delete an existing vpn-binding
24716       operationId: deleteNetworkVpnBindingsVpnBinding
24717       consumes:
24718         - application/json
24719         - application/xml
24720       produces:
24721         - application/json
24722         - application/xml
24723       responses:
24724         "default":
24725           description: Response codes found in [response codes](https://wiki.onap.org/).
24726       parameters:
24727         - name: vpn-id
24728           in: path
24729           description: VPN ID, globally unique within A&AI
24730           required: true
24731           type: string
24732           example: __VPN-ID__
24733         - name: resource-version
24734           in: query
24735           description: resource-version for concurrency
24736           required: true
24737           type: string
24738   /network/vpn-bindings:
24739     get:
24740       tags:
24741         - Network
24742       summary: returns vpn-bindings
24743       description: returns vpn-bindings
24744       operationId: getNetworkVpnBindings
24745       produces:
24746         - application/json
24747         - application/xml
24748       responses:
24749         "200":
24750           description: successful operation
24751           schema:
24752               $ref: "#/getDefinitions/vpn-bindings"
24753         "default":
24754           description: Response codes found in [response codes](https://wiki.onap.org/).
24755   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
24756     put:
24757       tags:
24758         - Network
24759       summary: see node definition for valid relationships
24760       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
24761       consumes:
24762         - application/json
24763         - application/xml
24764       produces:
24765         - application/json
24766         - application/xml
24767       responses:
24768         "default":
24769           description: Response codes found in [response codes](https://wiki.onap.org/).
24770       parameters:
24771         - name: equipment-name
24772           in: path
24773           required: true
24774           type: string
24775           example: __EQUIPMENT-NAME__
24776         - name: body
24777           in: body
24778           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
24779           required: true
24780           schema:
24781             $ref: "#/definitions/relationship"
24782     delete:
24783       tags:
24784         - Network
24785       summary: delete an existing relationship
24786       description: delete an existing relationship
24787       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
24788       consumes:
24789         - application/json
24790         - application/xml
24791       produces:
24792         - application/json
24793         - application/xml
24794       responses:
24795         "default":
24796           description: Response codes found in [response codes](https://wiki.onap.org/).
24797       parameters:
24798         - name: equipment-name
24799           in: path
24800           required: true
24801           type: string
24802           example: __EQUIPMENT-NAME__
24803   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
24804     put:
24805       tags:
24806         - Network
24807       summary: see node definition for valid relationships
24808       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
24809       consumes:
24810         - application/json
24811         - application/xml
24812       produces:
24813         - application/json
24814         - application/xml
24815       responses:
24816         "default":
24817           description: Response codes found in [response codes](https://wiki.onap.org/).
24818       parameters:
24819         - name: equipment-name
24820           in: path
24821           required: true
24822           type: string
24823           example: __EQUIPMENT-NAME__
24824         - name: interface-name
24825           in: path
24826           description: Name that identifies the physical interface
24827           required: true
24828           type: string
24829           example: __INTERFACE-NAME__
24830         - name: body
24831           in: body
24832           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
24833           required: true
24834           schema:
24835             $ref: "#/definitions/relationship"
24836     delete:
24837       tags:
24838         - Network
24839       summary: delete an existing relationship
24840       description: delete an existing relationship
24841       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
24842       consumes:
24843         - application/json
24844         - application/xml
24845       produces:
24846         - application/json
24847         - application/xml
24848       responses:
24849         "default":
24850           description: Response codes found in [response codes](https://wiki.onap.org/).
24851       parameters:
24852         - name: equipment-name
24853           in: path
24854           required: true
24855           type: string
24856           example: __EQUIPMENT-NAME__
24857         - name: interface-name
24858           in: path
24859           description: Name that identifies the physical interface
24860           required: true
24861           type: string
24862           example: __INTERFACE-NAME__
24863   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
24864     put:
24865       tags:
24866         - Network
24867       summary: see node definition for valid relationships
24868       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
24869       consumes:
24870         - application/json
24871         - application/xml
24872       produces:
24873         - application/json
24874         - application/xml
24875       responses:
24876         "default":
24877           description: Response codes found in [response codes](https://wiki.onap.org/).
24878       parameters:
24879         - name: equipment-name
24880           in: path
24881           required: true
24882           type: string
24883           example: __EQUIPMENT-NAME__
24884         - name: interface-name
24885           in: path
24886           description: Name that identifies the physical interface
24887           required: true
24888           type: string
24889           example: __INTERFACE-NAME__
24890         - name: pf-pci-id
24891           in: path
24892           description: Identifier for the sriov-pf
24893           required: true
24894           type: string
24895           example: __PF-PCI-ID__
24896         - name: body
24897           in: body
24898           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
24899           required: true
24900           schema:
24901             $ref: "#/definitions/relationship"
24902     delete:
24903       tags:
24904         - Network
24905       summary: delete an existing relationship
24906       description: delete an existing relationship
24907       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
24908       consumes:
24909         - application/json
24910         - application/xml
24911       produces:
24912         - application/json
24913         - application/xml
24914       responses:
24915         "default":
24916           description: Response codes found in [response codes](https://wiki.onap.org/).
24917       parameters:
24918         - name: equipment-name
24919           in: path
24920           required: true
24921           type: string
24922           example: __EQUIPMENT-NAME__
24923         - name: interface-name
24924           in: path
24925           description: Name that identifies the physical interface
24926           required: true
24927           type: string
24928           example: __INTERFACE-NAME__
24929         - name: pf-pci-id
24930           in: path
24931           description: Identifier for the sriov-pf
24932           required: true
24933           type: string
24934           example: __PF-PCI-ID__
24935   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
24936     get:
24937       tags:
24938         - Network
24939       summary: returns sriov-pf
24940       description: returns sriov-pf
24941       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24942       produces:
24943         - application/json
24944         - application/xml
24945       responses:
24946         "200":
24947           description: successful operation
24948           schema:
24949               $ref: "#/getDefinitions/sriov-pf"
24950         "default":
24951           description: Response codes found in [response codes](https://wiki.onap.org/).
24952       parameters:
24953         - name: equipment-name
24954           in: path
24955           required: true
24956           type: string
24957           example: __EQUIPMENT-NAME__
24958         - name: interface-name
24959           in: path
24960           description: Name that identifies the physical interface
24961           required: true
24962           type: string
24963           example: __INTERFACE-NAME__
24964         - name: pf-pci-id
24965           in: path
24966           description: Identifier for the sriov-pf
24967           required: true
24968           type: string
24969           example: __PF-PCI-ID__
24970         - name: prov-status
24971           in: query
24972           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24973           required: false
24974           type: string
24975         - name: prov-status
24976           in: query
24977           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24978           required: false
24979           type: string
24980     put:
24981       tags:
24982         - Network
24983       summary: create or update an existing sriov-pf
24984       description: |
24985         Create or update an existing sriov-pf.
24986         #
24987         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
24988       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24989       consumes:
24990         - application/json
24991         - application/xml
24992       produces:
24993         - application/json
24994         - application/xml
24995       responses:
24996         "default":
24997           description: Response codes found in [response codes](https://wiki.onap.org/).
24998       parameters:
24999         - name: equipment-name
25000           in: path
25001           required: true
25002           type: string
25003           example: __EQUIPMENT-NAME__
25004         - name: interface-name
25005           in: path
25006           description: Name that identifies the physical interface
25007           required: true
25008           type: string
25009           example: __INTERFACE-NAME__
25010         - name: pf-pci-id
25011           in: path
25012           description: Identifier for the sriov-pf
25013           required: true
25014           type: string
25015           example: __PF-PCI-ID__
25016         - name: body
25017           in: body
25018           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
25019           required: true
25020           schema:
25021             $ref: "#/definitions/sriov-pf"
25022     patch:
25023       tags:
25024         - Network
25025       summary: update an existing sriov-pf
25026       description: |
25027         Update an existing sriov-pf
25028         #
25029         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25030         The PUT operation will entirely replace an existing object.
25031         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.
25032         #
25033         Other differences between PUT and PATCH are:
25034         #
25035         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25036         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25037         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25038       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
25039       consumes:
25040         - application/json
25041         - application/xml
25042       produces:
25043         - application/json
25044         - application/xml
25045       responses:
25046         "default":
25047           description: Response codes found in [response codes](https://wiki.onap.org/).
25048       parameters:
25049         - name: equipment-name
25050           in: path
25051           required: true
25052           type: string
25053           example: __EQUIPMENT-NAME__
25054         - name: interface-name
25055           in: path
25056           description: Name that identifies the physical interface
25057           required: true
25058           type: string
25059           example: __INTERFACE-NAME__
25060         - name: pf-pci-id
25061           in: path
25062           description: Identifier for the sriov-pf
25063           required: true
25064           type: string
25065           example: __PF-PCI-ID__
25066         - name: body
25067           in: body
25068           description: sriov-pf object that needs to be created or updated.
25069           required: true
25070           schema:
25071             $ref: "#/patchDefinitions/sriov-pf"
25072     delete:
25073       tags:
25074         - Network
25075       summary: delete an existing sriov-pf
25076       description: delete an existing sriov-pf
25077       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
25078       consumes:
25079         - application/json
25080         - application/xml
25081       produces:
25082         - application/json
25083         - application/xml
25084       responses:
25085         "default":
25086           description: Response codes found in [response codes](https://wiki.onap.org/).
25087       parameters:
25088         - name: equipment-name
25089           in: path
25090           required: true
25091           type: string
25092           example: __EQUIPMENT-NAME__
25093         - name: interface-name
25094           in: path
25095           description: Name that identifies the physical interface
25096           required: true
25097           type: string
25098           example: __INTERFACE-NAME__
25099         - name: pf-pci-id
25100           in: path
25101           description: Identifier for the sriov-pf
25102           required: true
25103           type: string
25104           example: __PF-PCI-ID__
25105         - name: resource-version
25106           in: query
25107           description: resource-version for concurrency
25108           required: true
25109           type: string
25110   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
25111     get:
25112       tags:
25113         - Network
25114       summary: returns sriov-pfs
25115       description: returns sriov-pfs
25116       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
25117       produces:
25118         - application/json
25119         - application/xml
25120       responses:
25121         "200":
25122           description: successful operation
25123           schema:
25124               $ref: "#/getDefinitions/sriov-pfs"
25125         "default":
25126           description: Response codes found in [response codes](https://wiki.onap.org/).
25127       parameters:
25128         - name: equipment-name
25129           in: path
25130           required: true
25131           type: string
25132           example: __EQUIPMENT-NAME__
25133         - name: interface-name
25134           in: path
25135           description: Name that identifies the physical interface
25136           required: true
25137           type: string
25138           example: __INTERFACE-NAME__
25139         - name: prov-status
25140           in: query
25141           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25142           required: false
25143           type: string
25144         - name: prov-status
25145           in: query
25146           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25147           required: false
25148           type: string
25149   /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:
25150     put:
25151       tags:
25152         - Network
25153       summary: see node definition for valid relationships
25154       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25155       consumes:
25156         - application/json
25157         - application/xml
25158       produces:
25159         - application/json
25160         - application/xml
25161       responses:
25162         "default":
25163           description: Response codes found in [response codes](https://wiki.onap.org/).
25164       parameters:
25165         - name: equipment-name
25166           in: path
25167           required: true
25168           type: string
25169           example: __EQUIPMENT-NAME__
25170         - name: interface-name
25171           in: path
25172           description: Name that identifies the physical interface
25173           required: true
25174           type: string
25175           example: __INTERFACE-NAME__
25176         - name: interface-name
25177           in: path
25178           description: Name given to the interface
25179           required: true
25180           type: string
25181           example: __INTERFACE-NAME__
25182         - name: vlan-interface
25183           in: path
25184           description: String that identifies the interface
25185           required: true
25186           type: string
25187           example: __VLAN-INTERFACE__
25188         - name: body
25189           in: body
25190           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
25191           required: true
25192           schema:
25193             $ref: "#/definitions/relationship"
25194     delete:
25195       tags:
25196         - Network
25197       summary: delete an existing relationship
25198       description: delete an existing relationship
25199       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25200       consumes:
25201         - application/json
25202         - application/xml
25203       produces:
25204         - application/json
25205         - application/xml
25206       responses:
25207         "default":
25208           description: Response codes found in [response codes](https://wiki.onap.org/).
25209       parameters:
25210         - name: equipment-name
25211           in: path
25212           required: true
25213           type: string
25214           example: __EQUIPMENT-NAME__
25215         - name: interface-name
25216           in: path
25217           description: Name that identifies the physical interface
25218           required: true
25219           type: string
25220           example: __INTERFACE-NAME__
25221         - name: interface-name
25222           in: path
25223           description: Name given to the interface
25224           required: true
25225           type: string
25226           example: __INTERFACE-NAME__
25227         - name: vlan-interface
25228           in: path
25229           description: String that identifies the interface
25230           required: true
25231           type: string
25232           example: __VLAN-INTERFACE__
25233   /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:
25234     put:
25235       tags:
25236         - Network
25237       summary: see node definition for valid relationships
25238       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25239       consumes:
25240         - application/json
25241         - application/xml
25242       produces:
25243         - application/json
25244         - application/xml
25245       responses:
25246         "default":
25247           description: Response codes found in [response codes](https://wiki.onap.org/).
25248       parameters:
25249         - name: equipment-name
25250           in: path
25251           required: true
25252           type: string
25253           example: __EQUIPMENT-NAME__
25254         - name: interface-name
25255           in: path
25256           description: Name that identifies the physical interface
25257           required: true
25258           type: string
25259           example: __INTERFACE-NAME__
25260         - name: interface-name
25261           in: path
25262           description: Name given to the interface
25263           required: true
25264           type: string
25265           example: __INTERFACE-NAME__
25266         - name: vlan-interface
25267           in: path
25268           description: String that identifies the interface
25269           required: true
25270           type: string
25271           example: __VLAN-INTERFACE__
25272         - name: l3-interface-ipv4-address
25273           in: path
25274           description: IP address
25275           required: true
25276           type: string
25277           example: __L3-INTERFACE-IPV4-ADDRESS__
25278         - name: body
25279           in: body
25280           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25281           required: true
25282           schema:
25283             $ref: "#/definitions/relationship"
25284     delete:
25285       tags:
25286         - Network
25287       summary: delete an existing relationship
25288       description: delete an existing relationship
25289       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25290       consumes:
25291         - application/json
25292         - application/xml
25293       produces:
25294         - application/json
25295         - application/xml
25296       responses:
25297         "default":
25298           description: Response codes found in [response codes](https://wiki.onap.org/).
25299       parameters:
25300         - name: equipment-name
25301           in: path
25302           required: true
25303           type: string
25304           example: __EQUIPMENT-NAME__
25305         - name: interface-name
25306           in: path
25307           description: Name that identifies the physical interface
25308           required: true
25309           type: string
25310           example: __INTERFACE-NAME__
25311         - name: interface-name
25312           in: path
25313           description: Name given to the interface
25314           required: true
25315           type: string
25316           example: __INTERFACE-NAME__
25317         - name: vlan-interface
25318           in: path
25319           description: String that identifies the interface
25320           required: true
25321           type: string
25322           example: __VLAN-INTERFACE__
25323         - name: l3-interface-ipv4-address
25324           in: path
25325           description: IP address
25326           required: true
25327           type: string
25328           example: __L3-INTERFACE-IPV4-ADDRESS__
25329   /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}:
25330     get:
25331       tags:
25332         - Network
25333       summary: returns l3-interface-ipv4-address-list
25334       description: returns l3-interface-ipv4-address-list
25335       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25336       produces:
25337         - application/json
25338         - application/xml
25339       responses:
25340         "200":
25341           description: successful operation
25342           schema:
25343               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25344         "default":
25345           description: Response codes found in [response codes](https://wiki.onap.org/).
25346       parameters:
25347         - name: equipment-name
25348           in: path
25349           required: true
25350           type: string
25351           example: __EQUIPMENT-NAME__
25352         - name: interface-name
25353           in: path
25354           description: Name that identifies the physical interface
25355           required: true
25356           type: string
25357           example: __INTERFACE-NAME__
25358         - name: interface-name
25359           in: path
25360           description: Name given to the interface
25361           required: true
25362           type: string
25363           example: __INTERFACE-NAME__
25364         - name: vlan-interface
25365           in: path
25366           description: String that identifies the interface
25367           required: true
25368           type: string
25369           example: __VLAN-INTERFACE__
25370         - name: l3-interface-ipv4-address
25371           in: path
25372           description: IP address
25373           required: true
25374           type: string
25375           example: __L3-INTERFACE-IPV4-ADDRESS__
25376         - name: prov-status
25377           in: query
25378           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25379           required: false
25380           type: string
25381         - name: prov-status
25382           in: query
25383           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25384           required: false
25385           type: string
25386         - name: interface-id
25387           in: query
25388           description: ID of interface
25389           required: false
25390           type: string
25391         - name: macaddr
25392           in: query
25393           description: MAC address for the interface
25394           required: false
25395           type: string
25396         - name: network-name
25397           in: query
25398           description: Name of the network
25399           required: false
25400           type: string
25401         - name: vlan-id-inner
25402           in: query
25403           description: Inner VLAN tag
25404           required: false
25405           type: integer
25406           format: int64
25407         - name: vpn-key
25408           in: query
25409           description: This indicates the customers VPN ID associated with this vlan
25410           required: false
25411           type: string
25412         - name: vlan-id-inner
25413           in: query
25414           description: Inner VLAN tag
25415           required: false
25416           type: integer
25417           format: int64
25418         - name: neutron-network-id
25419           in: query
25420           description: Neutron network id of the interface that address belongs to
25421           required: false
25422           type: string
25423         - name: neutron-subnet-id
25424           in: query
25425           description: Neutron id of subnet that address belongs to
25426           required: false
25427           type: string
25428     put:
25429       tags:
25430         - Network
25431       summary: create or update an existing l3-interface-ipv4-address-list
25432       description: |
25433         Create or update an existing l3-interface-ipv4-address-list.
25434         #
25435         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
25436       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25437       consumes:
25438         - application/json
25439         - application/xml
25440       produces:
25441         - application/json
25442         - application/xml
25443       responses:
25444         "default":
25445           description: Response codes found in [response codes](https://wiki.onap.org/).
25446       parameters:
25447         - name: equipment-name
25448           in: path
25449           required: true
25450           type: string
25451           example: __EQUIPMENT-NAME__
25452         - name: interface-name
25453           in: path
25454           description: Name that identifies the physical interface
25455           required: true
25456           type: string
25457           example: __INTERFACE-NAME__
25458         - name: interface-name
25459           in: path
25460           description: Name given to the interface
25461           required: true
25462           type: string
25463           example: __INTERFACE-NAME__
25464         - name: vlan-interface
25465           in: path
25466           description: String that identifies the interface
25467           required: true
25468           type: string
25469           example: __VLAN-INTERFACE__
25470         - name: l3-interface-ipv4-address
25471           in: path
25472           description: IP address
25473           required: true
25474           type: string
25475           example: __L3-INTERFACE-IPV4-ADDRESS__
25476         - name: body
25477           in: body
25478           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25479           required: true
25480           schema:
25481             $ref: "#/definitions/l3-interface-ipv4-address-list"
25482     patch:
25483       tags:
25484         - Network
25485       summary: update an existing l3-interface-ipv4-address-list
25486       description: |
25487         Update an existing l3-interface-ipv4-address-list
25488         #
25489         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25490         The PUT operation will entirely replace an existing object.
25491         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.
25492         #
25493         Other differences between PUT and PATCH are:
25494         #
25495         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25496         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25497         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25498       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25499       consumes:
25500         - application/json
25501         - application/xml
25502       produces:
25503         - application/json
25504         - application/xml
25505       responses:
25506         "default":
25507           description: Response codes found in [response codes](https://wiki.onap.org/).
25508       parameters:
25509         - name: equipment-name
25510           in: path
25511           required: true
25512           type: string
25513           example: __EQUIPMENT-NAME__
25514         - name: interface-name
25515           in: path
25516           description: Name that identifies the physical interface
25517           required: true
25518           type: string
25519           example: __INTERFACE-NAME__
25520         - name: interface-name
25521           in: path
25522           description: Name given to the interface
25523           required: true
25524           type: string
25525           example: __INTERFACE-NAME__
25526         - name: vlan-interface
25527           in: path
25528           description: String that identifies the interface
25529           required: true
25530           type: string
25531           example: __VLAN-INTERFACE__
25532         - name: l3-interface-ipv4-address
25533           in: path
25534           description: IP address
25535           required: true
25536           type: string
25537           example: __L3-INTERFACE-IPV4-ADDRESS__
25538         - name: body
25539           in: body
25540           description: l3-interface-ipv4-address-list object that needs to be created or updated.
25541           required: true
25542           schema:
25543             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25544     delete:
25545       tags:
25546         - Network
25547       summary: delete an existing l3-interface-ipv4-address-list
25548       description: delete an existing l3-interface-ipv4-address-list
25549       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25550       consumes:
25551         - application/json
25552         - application/xml
25553       produces:
25554         - application/json
25555         - application/xml
25556       responses:
25557         "default":
25558           description: Response codes found in [response codes](https://wiki.onap.org/).
25559       parameters:
25560         - name: equipment-name
25561           in: path
25562           required: true
25563           type: string
25564           example: __EQUIPMENT-NAME__
25565         - name: interface-name
25566           in: path
25567           description: Name that identifies the physical interface
25568           required: true
25569           type: string
25570           example: __INTERFACE-NAME__
25571         - name: interface-name
25572           in: path
25573           description: Name given to the interface
25574           required: true
25575           type: string
25576           example: __INTERFACE-NAME__
25577         - name: vlan-interface
25578           in: path
25579           description: String that identifies the interface
25580           required: true
25581           type: string
25582           example: __VLAN-INTERFACE__
25583         - name: l3-interface-ipv4-address
25584           in: path
25585           description: IP address
25586           required: true
25587           type: string
25588           example: __L3-INTERFACE-IPV4-ADDRESS__
25589         - name: resource-version
25590           in: query
25591           description: resource-version for concurrency
25592           required: true
25593           type: string
25594   /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:
25595     put:
25596       tags:
25597         - Network
25598       summary: see node definition for valid relationships
25599       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25600       consumes:
25601         - application/json
25602         - application/xml
25603       produces:
25604         - application/json
25605         - application/xml
25606       responses:
25607         "default":
25608           description: Response codes found in [response codes](https://wiki.onap.org/).
25609       parameters:
25610         - name: equipment-name
25611           in: path
25612           required: true
25613           type: string
25614           example: __EQUIPMENT-NAME__
25615         - name: interface-name
25616           in: path
25617           description: Name that identifies the physical interface
25618           required: true
25619           type: string
25620           example: __INTERFACE-NAME__
25621         - name: interface-name
25622           in: path
25623           description: Name given to the interface
25624           required: true
25625           type: string
25626           example: __INTERFACE-NAME__
25627         - name: vlan-interface
25628           in: path
25629           description: String that identifies the interface
25630           required: true
25631           type: string
25632           example: __VLAN-INTERFACE__
25633         - name: l3-interface-ipv6-address
25634           in: path
25635           description: IP address
25636           required: true
25637           type: string
25638           example: __L3-INTERFACE-IPV6-ADDRESS__
25639         - name: body
25640           in: body
25641           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25642           required: true
25643           schema:
25644             $ref: "#/definitions/relationship"
25645     delete:
25646       tags:
25647         - Network
25648       summary: delete an existing relationship
25649       description: delete an existing relationship
25650       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25651       consumes:
25652         - application/json
25653         - application/xml
25654       produces:
25655         - application/json
25656         - application/xml
25657       responses:
25658         "default":
25659           description: Response codes found in [response codes](https://wiki.onap.org/).
25660       parameters:
25661         - name: equipment-name
25662           in: path
25663           required: true
25664           type: string
25665           example: __EQUIPMENT-NAME__
25666         - name: interface-name
25667           in: path
25668           description: Name that identifies the physical interface
25669           required: true
25670           type: string
25671           example: __INTERFACE-NAME__
25672         - name: interface-name
25673           in: path
25674           description: Name given to the interface
25675           required: true
25676           type: string
25677           example: __INTERFACE-NAME__
25678         - name: vlan-interface
25679           in: path
25680           description: String that identifies the interface
25681           required: true
25682           type: string
25683           example: __VLAN-INTERFACE__
25684         - name: l3-interface-ipv6-address
25685           in: path
25686           description: IP address
25687           required: true
25688           type: string
25689           example: __L3-INTERFACE-IPV6-ADDRESS__
25690   /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}:
25691     get:
25692       tags:
25693         - Network
25694       summary: returns l3-interface-ipv6-address-list
25695       description: returns l3-interface-ipv6-address-list
25696       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25697       produces:
25698         - application/json
25699         - application/xml
25700       responses:
25701         "200":
25702           description: successful operation
25703           schema:
25704               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25705         "default":
25706           description: Response codes found in [response codes](https://wiki.onap.org/).
25707       parameters:
25708         - name: equipment-name
25709           in: path
25710           required: true
25711           type: string
25712           example: __EQUIPMENT-NAME__
25713         - name: interface-name
25714           in: path
25715           description: Name that identifies the physical interface
25716           required: true
25717           type: string
25718           example: __INTERFACE-NAME__
25719         - name: interface-name
25720           in: path
25721           description: Name given to the interface
25722           required: true
25723           type: string
25724           example: __INTERFACE-NAME__
25725         - name: vlan-interface
25726           in: path
25727           description: String that identifies the interface
25728           required: true
25729           type: string
25730           example: __VLAN-INTERFACE__
25731         - name: l3-interface-ipv6-address
25732           in: path
25733           description: IP address
25734           required: true
25735           type: string
25736           example: __L3-INTERFACE-IPV6-ADDRESS__
25737         - name: prov-status
25738           in: query
25739           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25740           required: false
25741           type: string
25742         - name: prov-status
25743           in: query
25744           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25745           required: false
25746           type: string
25747         - name: interface-id
25748           in: query
25749           description: ID of interface
25750           required: false
25751           type: string
25752         - name: macaddr
25753           in: query
25754           description: MAC address for the interface
25755           required: false
25756           type: string
25757         - name: network-name
25758           in: query
25759           description: Name of the network
25760           required: false
25761           type: string
25762         - name: vlan-id-inner
25763           in: query
25764           description: Inner VLAN tag
25765           required: false
25766           type: integer
25767           format: int64
25768         - name: vpn-key
25769           in: query
25770           description: This indicates the customers VPN ID associated with this vlan
25771           required: false
25772           type: string
25773         - name: vlan-id-inner
25774           in: query
25775           description: Inner VLAN tag
25776           required: false
25777           type: integer
25778           format: int64
25779         - name: neutron-network-id
25780           in: query
25781           description: Neutron network id of the interface that address belongs to
25782           required: false
25783           type: string
25784         - name: neutron-subnet-id
25785           in: query
25786           description: Neutron id of subnet that address belongs to
25787           required: false
25788           type: string
25789     put:
25790       tags:
25791         - Network
25792       summary: create or update an existing l3-interface-ipv6-address-list
25793       description: |
25794         Create or update an existing l3-interface-ipv6-address-list.
25795         #
25796         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
25797       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25798       consumes:
25799         - application/json
25800         - application/xml
25801       produces:
25802         - application/json
25803         - application/xml
25804       responses:
25805         "default":
25806           description: Response codes found in [response codes](https://wiki.onap.org/).
25807       parameters:
25808         - name: equipment-name
25809           in: path
25810           required: true
25811           type: string
25812           example: __EQUIPMENT-NAME__
25813         - name: interface-name
25814           in: path
25815           description: Name that identifies the physical interface
25816           required: true
25817           type: string
25818           example: __INTERFACE-NAME__
25819         - name: interface-name
25820           in: path
25821           description: Name given to the interface
25822           required: true
25823           type: string
25824           example: __INTERFACE-NAME__
25825         - name: vlan-interface
25826           in: path
25827           description: String that identifies the interface
25828           required: true
25829           type: string
25830           example: __VLAN-INTERFACE__
25831         - name: l3-interface-ipv6-address
25832           in: path
25833           description: IP address
25834           required: true
25835           type: string
25836           example: __L3-INTERFACE-IPV6-ADDRESS__
25837         - name: body
25838           in: body
25839           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25840           required: true
25841           schema:
25842             $ref: "#/definitions/l3-interface-ipv6-address-list"
25843     patch:
25844       tags:
25845         - Network
25846       summary: update an existing l3-interface-ipv6-address-list
25847       description: |
25848         Update an existing l3-interface-ipv6-address-list
25849         #
25850         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25851         The PUT operation will entirely replace an existing object.
25852         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.
25853         #
25854         Other differences between PUT and PATCH are:
25855         #
25856         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25857         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25858         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25859       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25860       consumes:
25861         - application/json
25862         - application/xml
25863       produces:
25864         - application/json
25865         - application/xml
25866       responses:
25867         "default":
25868           description: Response codes found in [response codes](https://wiki.onap.org/).
25869       parameters:
25870         - name: equipment-name
25871           in: path
25872           required: true
25873           type: string
25874           example: __EQUIPMENT-NAME__
25875         - name: interface-name
25876           in: path
25877           description: Name that identifies the physical interface
25878           required: true
25879           type: string
25880           example: __INTERFACE-NAME__
25881         - name: interface-name
25882           in: path
25883           description: Name given to the interface
25884           required: true
25885           type: string
25886           example: __INTERFACE-NAME__
25887         - name: vlan-interface
25888           in: path
25889           description: String that identifies the interface
25890           required: true
25891           type: string
25892           example: __VLAN-INTERFACE__
25893         - name: l3-interface-ipv6-address
25894           in: path
25895           description: IP address
25896           required: true
25897           type: string
25898           example: __L3-INTERFACE-IPV6-ADDRESS__
25899         - name: body
25900           in: body
25901           description: l3-interface-ipv6-address-list object that needs to be created or updated.
25902           required: true
25903           schema:
25904             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25905     delete:
25906       tags:
25907         - Network
25908       summary: delete an existing l3-interface-ipv6-address-list
25909       description: delete an existing l3-interface-ipv6-address-list
25910       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25911       consumes:
25912         - application/json
25913         - application/xml
25914       produces:
25915         - application/json
25916         - application/xml
25917       responses:
25918         "default":
25919           description: Response codes found in [response codes](https://wiki.onap.org/).
25920       parameters:
25921         - name: equipment-name
25922           in: path
25923           required: true
25924           type: string
25925           example: __EQUIPMENT-NAME__
25926         - name: interface-name
25927           in: path
25928           description: Name that identifies the physical interface
25929           required: true
25930           type: string
25931           example: __INTERFACE-NAME__
25932         - name: interface-name
25933           in: path
25934           description: Name given to the interface
25935           required: true
25936           type: string
25937           example: __INTERFACE-NAME__
25938         - name: vlan-interface
25939           in: path
25940           description: String that identifies the interface
25941           required: true
25942           type: string
25943           example: __VLAN-INTERFACE__
25944         - name: l3-interface-ipv6-address
25945           in: path
25946           description: IP address
25947           required: true
25948           type: string
25949           example: __L3-INTERFACE-IPV6-ADDRESS__
25950         - name: resource-version
25951           in: query
25952           description: resource-version for concurrency
25953           required: true
25954           type: string
25955   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25956     get:
25957       tags:
25958         - Network
25959       summary: returns vlan
25960       description: returns vlan
25961       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25962       produces:
25963         - application/json
25964         - application/xml
25965       responses:
25966         "200":
25967           description: successful operation
25968           schema:
25969               $ref: "#/getDefinitions/vlan"
25970         "default":
25971           description: Response codes found in [response codes](https://wiki.onap.org/).
25972       parameters:
25973         - name: equipment-name
25974           in: path
25975           required: true
25976           type: string
25977           example: __EQUIPMENT-NAME__
25978         - name: interface-name
25979           in: path
25980           description: Name that identifies the physical interface
25981           required: true
25982           type: string
25983           example: __INTERFACE-NAME__
25984         - name: interface-name
25985           in: path
25986           description: Name given to the interface
25987           required: true
25988           type: string
25989           example: __INTERFACE-NAME__
25990         - name: vlan-interface
25991           in: path
25992           description: String that identifies the interface
25993           required: true
25994           type: string
25995           example: __VLAN-INTERFACE__
25996         - name: prov-status
25997           in: query
25998           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25999           required: false
26000           type: string
26001         - name: prov-status
26002           in: query
26003           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26004           required: false
26005           type: string
26006         - name: interface-id
26007           in: query
26008           description: ID of interface
26009           required: false
26010           type: string
26011         - name: macaddr
26012           in: query
26013           description: MAC address for the interface
26014           required: false
26015           type: string
26016         - name: network-name
26017           in: query
26018           description: Name of the network
26019           required: false
26020           type: string
26021         - name: vlan-id-inner
26022           in: query
26023           description: Inner VLAN tag
26024           required: false
26025           type: integer
26026           format: int64
26027         - name: vpn-key
26028           in: query
26029           description: This indicates the customers VPN ID associated with this vlan
26030           required: false
26031           type: string
26032     put:
26033       tags:
26034         - Network
26035       summary: create or update an existing vlan
26036       description: |
26037         Create or update an existing vlan.
26038         #
26039         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
26040       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26041       consumes:
26042         - application/json
26043         - application/xml
26044       produces:
26045         - application/json
26046         - application/xml
26047       responses:
26048         "default":
26049           description: Response codes found in [response codes](https://wiki.onap.org/).
26050       parameters:
26051         - name: equipment-name
26052           in: path
26053           required: true
26054           type: string
26055           example: __EQUIPMENT-NAME__
26056         - name: interface-name
26057           in: path
26058           description: Name that identifies the physical interface
26059           required: true
26060           type: string
26061           example: __INTERFACE-NAME__
26062         - name: interface-name
26063           in: path
26064           description: Name given to the interface
26065           required: true
26066           type: string
26067           example: __INTERFACE-NAME__
26068         - name: vlan-interface
26069           in: path
26070           description: String that identifies the interface
26071           required: true
26072           type: string
26073           example: __VLAN-INTERFACE__
26074         - name: body
26075           in: body
26076           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
26077           required: true
26078           schema:
26079             $ref: "#/definitions/vlan"
26080     patch:
26081       tags:
26082         - Network
26083       summary: update an existing vlan
26084       description: |
26085         Update an existing vlan
26086         #
26087         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26088         The PUT operation will entirely replace an existing object.
26089         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.
26090         #
26091         Other differences between PUT and PATCH are:
26092         #
26093         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26094         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26095         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26096       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26097       consumes:
26098         - application/json
26099         - application/xml
26100       produces:
26101         - application/json
26102         - application/xml
26103       responses:
26104         "default":
26105           description: Response codes found in [response codes](https://wiki.onap.org/).
26106       parameters:
26107         - name: equipment-name
26108           in: path
26109           required: true
26110           type: string
26111           example: __EQUIPMENT-NAME__
26112         - name: interface-name
26113           in: path
26114           description: Name that identifies the physical interface
26115           required: true
26116           type: string
26117           example: __INTERFACE-NAME__
26118         - name: interface-name
26119           in: path
26120           description: Name given to the interface
26121           required: true
26122           type: string
26123           example: __INTERFACE-NAME__
26124         - name: vlan-interface
26125           in: path
26126           description: String that identifies the interface
26127           required: true
26128           type: string
26129           example: __VLAN-INTERFACE__
26130         - name: body
26131           in: body
26132           description: vlan object that needs to be created or updated.
26133           required: true
26134           schema:
26135             $ref: "#/patchDefinitions/vlan"
26136     delete:
26137       tags:
26138         - Network
26139       summary: delete an existing vlan
26140       description: delete an existing vlan
26141       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
26142       consumes:
26143         - application/json
26144         - application/xml
26145       produces:
26146         - application/json
26147         - application/xml
26148       responses:
26149         "default":
26150           description: Response codes found in [response codes](https://wiki.onap.org/).
26151       parameters:
26152         - name: equipment-name
26153           in: path
26154           required: true
26155           type: string
26156           example: __EQUIPMENT-NAME__
26157         - name: interface-name
26158           in: path
26159           description: Name that identifies the physical interface
26160           required: true
26161           type: string
26162           example: __INTERFACE-NAME__
26163         - name: interface-name
26164           in: path
26165           description: Name given to the interface
26166           required: true
26167           type: string
26168           example: __INTERFACE-NAME__
26169         - name: vlan-interface
26170           in: path
26171           description: String that identifies the interface
26172           required: true
26173           type: string
26174           example: __VLAN-INTERFACE__
26175         - name: resource-version
26176           in: query
26177           description: resource-version for concurrency
26178           required: true
26179           type: string
26180   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
26181     get:
26182       tags:
26183         - Network
26184       summary: returns vlans
26185       description: returns vlans
26186       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
26187       produces:
26188         - application/json
26189         - application/xml
26190       responses:
26191         "200":
26192           description: successful operation
26193           schema:
26194               $ref: "#/getDefinitions/vlans"
26195         "default":
26196           description: Response codes found in [response codes](https://wiki.onap.org/).
26197       parameters:
26198         - name: equipment-name
26199           in: path
26200           required: true
26201           type: string
26202           example: __EQUIPMENT-NAME__
26203         - name: interface-name
26204           in: path
26205           description: Name that identifies the physical interface
26206           required: true
26207           type: string
26208           example: __INTERFACE-NAME__
26209         - name: interface-name
26210           in: path
26211           description: Name given to the interface
26212           required: true
26213           type: string
26214           example: __INTERFACE-NAME__
26215         - name: prov-status
26216           in: query
26217           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26218           required: false
26219           type: string
26220         - name: prov-status
26221           in: query
26222           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26223           required: false
26224           type: string
26225         - name: interface-id
26226           in: query
26227           description: ID of interface
26228           required: false
26229           type: string
26230         - name: macaddr
26231           in: query
26232           description: MAC address for the interface
26233           required: false
26234           type: string
26235         - name: network-name
26236           in: query
26237           description: Name of the network
26238           required: false
26239           type: string
26240   /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:
26241     put:
26242       tags:
26243         - Network
26244       summary: see node definition for valid relationships
26245       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26246       consumes:
26247         - application/json
26248         - application/xml
26249       produces:
26250         - application/json
26251         - application/xml
26252       responses:
26253         "default":
26254           description: Response codes found in [response codes](https://wiki.onap.org/).
26255       parameters:
26256         - name: equipment-name
26257           in: path
26258           required: true
26259           type: string
26260           example: __EQUIPMENT-NAME__
26261         - name: interface-name
26262           in: path
26263           description: Name that identifies the physical interface
26264           required: true
26265           type: string
26266           example: __INTERFACE-NAME__
26267         - name: interface-name
26268           in: path
26269           description: Name given to the interface
26270           required: true
26271           type: string
26272           example: __INTERFACE-NAME__
26273         - name: pci-id
26274           in: path
26275           description: PCI ID used to identify the sriov-vf
26276           required: true
26277           type: string
26278           example: __PCI-ID__
26279         - name: body
26280           in: body
26281           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26282           required: true
26283           schema:
26284             $ref: "#/definitions/relationship"
26285     delete:
26286       tags:
26287         - Network
26288       summary: delete an existing relationship
26289       description: delete an existing relationship
26290       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26291       consumes:
26292         - application/json
26293         - application/xml
26294       produces:
26295         - application/json
26296         - application/xml
26297       responses:
26298         "default":
26299           description: Response codes found in [response codes](https://wiki.onap.org/).
26300       parameters:
26301         - name: equipment-name
26302           in: path
26303           required: true
26304           type: string
26305           example: __EQUIPMENT-NAME__
26306         - name: interface-name
26307           in: path
26308           description: Name that identifies the physical interface
26309           required: true
26310           type: string
26311           example: __INTERFACE-NAME__
26312         - name: interface-name
26313           in: path
26314           description: Name given to the interface
26315           required: true
26316           type: string
26317           example: __INTERFACE-NAME__
26318         - name: pci-id
26319           in: path
26320           description: PCI ID used to identify the sriov-vf
26321           required: true
26322           type: string
26323           example: __PCI-ID__
26324   /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}:
26325     get:
26326       tags:
26327         - Network
26328       summary: returns sriov-vf
26329       description: returns sriov-vf
26330       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26331       produces:
26332         - application/json
26333         - application/xml
26334       responses:
26335         "200":
26336           description: successful operation
26337           schema:
26338               $ref: "#/getDefinitions/sriov-vf"
26339         "default":
26340           description: Response codes found in [response codes](https://wiki.onap.org/).
26341       parameters:
26342         - name: equipment-name
26343           in: path
26344           required: true
26345           type: string
26346           example: __EQUIPMENT-NAME__
26347         - name: interface-name
26348           in: path
26349           description: Name that identifies the physical interface
26350           required: true
26351           type: string
26352           example: __INTERFACE-NAME__
26353         - name: interface-name
26354           in: path
26355           description: Name given to the interface
26356           required: true
26357           type: string
26358           example: __INTERFACE-NAME__
26359         - name: pci-id
26360           in: path
26361           description: PCI ID used to identify the sriov-vf
26362           required: true
26363           type: string
26364           example: __PCI-ID__
26365         - name: prov-status
26366           in: query
26367           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26368           required: false
26369           type: string
26370         - name: prov-status
26371           in: query
26372           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26373           required: false
26374           type: string
26375         - name: interface-id
26376           in: query
26377           description: ID of interface
26378           required: false
26379           type: string
26380         - name: macaddr
26381           in: query
26382           description: MAC address for the interface
26383           required: false
26384           type: string
26385         - name: network-name
26386           in: query
26387           description: Name of the network
26388           required: false
26389           type: string
26390         - name: vf-vlan-filter
26391           in: query
26392           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
26393           required: false
26394           type: string
26395         - name: vf-mac-filter
26396           in: query
26397           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
26398           required: false
26399           type: string
26400         - name: vf-vlan-strip
26401           in: query
26402           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
26403           required: false
26404           type: boolean
26405         - name: neutron-network-id
26406           in: query
26407           description: Neutron network id of the interface
26408           required: false
26409           type: string
26410     put:
26411       tags:
26412         - Network
26413       summary: create or update an existing sriov-vf
26414       description: |
26415         Create or update an existing sriov-vf.
26416         #
26417         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
26418       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26419       consumes:
26420         - application/json
26421         - application/xml
26422       produces:
26423         - application/json
26424         - application/xml
26425       responses:
26426         "default":
26427           description: Response codes found in [response codes](https://wiki.onap.org/).
26428       parameters:
26429         - name: equipment-name
26430           in: path
26431           required: true
26432           type: string
26433           example: __EQUIPMENT-NAME__
26434         - name: interface-name
26435           in: path
26436           description: Name that identifies the physical interface
26437           required: true
26438           type: string
26439           example: __INTERFACE-NAME__
26440         - name: interface-name
26441           in: path
26442           description: Name given to the interface
26443           required: true
26444           type: string
26445           example: __INTERFACE-NAME__
26446         - name: pci-id
26447           in: path
26448           description: PCI ID used to identify the sriov-vf
26449           required: true
26450           type: string
26451           example: __PCI-ID__
26452         - name: body
26453           in: body
26454           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26455           required: true
26456           schema:
26457             $ref: "#/definitions/sriov-vf"
26458     patch:
26459       tags:
26460         - Network
26461       summary: update an existing sriov-vf
26462       description: |
26463         Update an existing sriov-vf
26464         #
26465         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26466         The PUT operation will entirely replace an existing object.
26467         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.
26468         #
26469         Other differences between PUT and PATCH are:
26470         #
26471         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26472         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26473         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26474       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26475       consumes:
26476         - application/json
26477         - application/xml
26478       produces:
26479         - application/json
26480         - application/xml
26481       responses:
26482         "default":
26483           description: Response codes found in [response codes](https://wiki.onap.org/).
26484       parameters:
26485         - name: equipment-name
26486           in: path
26487           required: true
26488           type: string
26489           example: __EQUIPMENT-NAME__
26490         - name: interface-name
26491           in: path
26492           description: Name that identifies the physical interface
26493           required: true
26494           type: string
26495           example: __INTERFACE-NAME__
26496         - name: interface-name
26497           in: path
26498           description: Name given to the interface
26499           required: true
26500           type: string
26501           example: __INTERFACE-NAME__
26502         - name: pci-id
26503           in: path
26504           description: PCI ID used to identify the sriov-vf
26505           required: true
26506           type: string
26507           example: __PCI-ID__
26508         - name: body
26509           in: body
26510           description: sriov-vf object that needs to be created or updated.
26511           required: true
26512           schema:
26513             $ref: "#/patchDefinitions/sriov-vf"
26514     delete:
26515       tags:
26516         - Network
26517       summary: delete an existing sriov-vf
26518       description: delete an existing sriov-vf
26519       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26520       consumes:
26521         - application/json
26522         - application/xml
26523       produces:
26524         - application/json
26525         - application/xml
26526       responses:
26527         "default":
26528           description: Response codes found in [response codes](https://wiki.onap.org/).
26529       parameters:
26530         - name: equipment-name
26531           in: path
26532           required: true
26533           type: string
26534           example: __EQUIPMENT-NAME__
26535         - name: interface-name
26536           in: path
26537           description: Name that identifies the physical interface
26538           required: true
26539           type: string
26540           example: __INTERFACE-NAME__
26541         - name: interface-name
26542           in: path
26543           description: Name given to the interface
26544           required: true
26545           type: string
26546           example: __INTERFACE-NAME__
26547         - name: pci-id
26548           in: path
26549           description: PCI ID used to identify the sriov-vf
26550           required: true
26551           type: string
26552           example: __PCI-ID__
26553         - name: resource-version
26554           in: query
26555           description: resource-version for concurrency
26556           required: true
26557           type: string
26558   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26559     get:
26560       tags:
26561         - Network
26562       summary: returns sriov-vfs
26563       description: returns sriov-vfs
26564       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
26565       produces:
26566         - application/json
26567         - application/xml
26568       responses:
26569         "200":
26570           description: successful operation
26571           schema:
26572               $ref: "#/getDefinitions/sriov-vfs"
26573         "default":
26574           description: Response codes found in [response codes](https://wiki.onap.org/).
26575       parameters:
26576         - name: equipment-name
26577           in: path
26578           required: true
26579           type: string
26580           example: __EQUIPMENT-NAME__
26581         - name: interface-name
26582           in: path
26583           description: Name that identifies the physical interface
26584           required: true
26585           type: string
26586           example: __INTERFACE-NAME__
26587         - name: interface-name
26588           in: path
26589           description: Name given to the interface
26590           required: true
26591           type: string
26592           example: __INTERFACE-NAME__
26593         - name: prov-status
26594           in: query
26595           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26596           required: false
26597           type: string
26598         - name: prov-status
26599           in: query
26600           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26601           required: false
26602           type: string
26603         - name: interface-id
26604           in: query
26605           description: ID of interface
26606           required: false
26607           type: string
26608         - name: macaddr
26609           in: query
26610           description: MAC address for the interface
26611           required: false
26612           type: string
26613         - name: network-name
26614           in: query
26615           description: Name of the network
26616           required: false
26617           type: string
26618   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26619     put:
26620       tags:
26621         - Network
26622       summary: see node definition for valid relationships
26623       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
26624       consumes:
26625         - application/json
26626         - application/xml
26627       produces:
26628         - application/json
26629         - application/xml
26630       responses:
26631         "default":
26632           description: Response codes found in [response codes](https://wiki.onap.org/).
26633       parameters:
26634         - name: equipment-name
26635           in: path
26636           required: true
26637           type: string
26638           example: __EQUIPMENT-NAME__
26639         - name: interface-name
26640           in: path
26641           description: Name that identifies the physical interface
26642           required: true
26643           type: string
26644           example: __INTERFACE-NAME__
26645         - name: interface-name
26646           in: path
26647           description: Name given to the interface
26648           required: true
26649           type: string
26650           example: __INTERFACE-NAME__
26651         - name: body
26652           in: body
26653           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
26654           required: true
26655           schema:
26656             $ref: "#/definitions/relationship"
26657     delete:
26658       tags:
26659         - Network
26660       summary: delete an existing relationship
26661       description: delete an existing relationship
26662       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
26663       consumes:
26664         - application/json
26665         - application/xml
26666       produces:
26667         - application/json
26668         - application/xml
26669       responses:
26670         "default":
26671           description: Response codes found in [response codes](https://wiki.onap.org/).
26672       parameters:
26673         - name: equipment-name
26674           in: path
26675           required: true
26676           type: string
26677           example: __EQUIPMENT-NAME__
26678         - name: interface-name
26679           in: path
26680           description: Name that identifies the physical interface
26681           required: true
26682           type: string
26683           example: __INTERFACE-NAME__
26684         - name: interface-name
26685           in: path
26686           description: Name given to the interface
26687           required: true
26688           type: string
26689           example: __INTERFACE-NAME__
26690   /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:
26691     put:
26692       tags:
26693         - Network
26694       summary: see node definition for valid relationships
26695       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26696       consumes:
26697         - application/json
26698         - application/xml
26699       produces:
26700         - application/json
26701         - application/xml
26702       responses:
26703         "default":
26704           description: Response codes found in [response codes](https://wiki.onap.org/).
26705       parameters:
26706         - name: equipment-name
26707           in: path
26708           required: true
26709           type: string
26710           example: __EQUIPMENT-NAME__
26711         - name: interface-name
26712           in: path
26713           description: Name that identifies the physical interface
26714           required: true
26715           type: string
26716           example: __INTERFACE-NAME__
26717         - name: interface-name
26718           in: path
26719           description: Name given to the interface
26720           required: true
26721           type: string
26722           example: __INTERFACE-NAME__
26723         - name: l3-interface-ipv4-address
26724           in: path
26725           description: IP address
26726           required: true
26727           type: string
26728           example: __L3-INTERFACE-IPV4-ADDRESS__
26729         - name: body
26730           in: body
26731           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26732           required: true
26733           schema:
26734             $ref: "#/definitions/relationship"
26735     delete:
26736       tags:
26737         - Network
26738       summary: delete an existing relationship
26739       description: delete an existing relationship
26740       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26741       consumes:
26742         - application/json
26743         - application/xml
26744       produces:
26745         - application/json
26746         - application/xml
26747       responses:
26748         "default":
26749           description: Response codes found in [response codes](https://wiki.onap.org/).
26750       parameters:
26751         - name: equipment-name
26752           in: path
26753           required: true
26754           type: string
26755           example: __EQUIPMENT-NAME__
26756         - name: interface-name
26757           in: path
26758           description: Name that identifies the physical interface
26759           required: true
26760           type: string
26761           example: __INTERFACE-NAME__
26762         - name: interface-name
26763           in: path
26764           description: Name given to the interface
26765           required: true
26766           type: string
26767           example: __INTERFACE-NAME__
26768         - name: l3-interface-ipv4-address
26769           in: path
26770           description: IP address
26771           required: true
26772           type: string
26773           example: __L3-INTERFACE-IPV4-ADDRESS__
26774   /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}:
26775     get:
26776       tags:
26777         - Network
26778       summary: returns l3-interface-ipv4-address-list
26779       description: returns l3-interface-ipv4-address-list
26780       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26781       produces:
26782         - application/json
26783         - application/xml
26784       responses:
26785         "200":
26786           description: successful operation
26787           schema:
26788               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26789         "default":
26790           description: Response codes found in [response codes](https://wiki.onap.org/).
26791       parameters:
26792         - name: equipment-name
26793           in: path
26794           required: true
26795           type: string
26796           example: __EQUIPMENT-NAME__
26797         - name: interface-name
26798           in: path
26799           description: Name that identifies the physical interface
26800           required: true
26801           type: string
26802           example: __INTERFACE-NAME__
26803         - name: interface-name
26804           in: path
26805           description: Name given to the interface
26806           required: true
26807           type: string
26808           example: __INTERFACE-NAME__
26809         - name: l3-interface-ipv4-address
26810           in: path
26811           description: IP address
26812           required: true
26813           type: string
26814           example: __L3-INTERFACE-IPV4-ADDRESS__
26815         - name: prov-status
26816           in: query
26817           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26818           required: false
26819           type: string
26820         - name: prov-status
26821           in: query
26822           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26823           required: false
26824           type: string
26825         - name: interface-id
26826           in: query
26827           description: ID of interface
26828           required: false
26829           type: string
26830         - name: macaddr
26831           in: query
26832           description: MAC address for the interface
26833           required: false
26834           type: string
26835         - name: network-name
26836           in: query
26837           description: Name of the network
26838           required: false
26839           type: string
26840         - name: vlan-id-inner
26841           in: query
26842           description: Inner VLAN tag
26843           required: false
26844           type: integer
26845           format: int64
26846         - name: neutron-network-id
26847           in: query
26848           description: Neutron network id of the interface that address belongs to
26849           required: false
26850           type: string
26851         - name: neutron-subnet-id
26852           in: query
26853           description: Neutron id of subnet that address belongs to
26854           required: false
26855           type: string
26856     put:
26857       tags:
26858         - Network
26859       summary: create or update an existing l3-interface-ipv4-address-list
26860       description: |
26861         Create or update an existing l3-interface-ipv4-address-list.
26862         #
26863         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
26864       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26865       consumes:
26866         - application/json
26867         - application/xml
26868       produces:
26869         - application/json
26870         - application/xml
26871       responses:
26872         "default":
26873           description: Response codes found in [response codes](https://wiki.onap.org/).
26874       parameters:
26875         - name: equipment-name
26876           in: path
26877           required: true
26878           type: string
26879           example: __EQUIPMENT-NAME__
26880         - name: interface-name
26881           in: path
26882           description: Name that identifies the physical interface
26883           required: true
26884           type: string
26885           example: __INTERFACE-NAME__
26886         - name: interface-name
26887           in: path
26888           description: Name given to the interface
26889           required: true
26890           type: string
26891           example: __INTERFACE-NAME__
26892         - name: l3-interface-ipv4-address
26893           in: path
26894           description: IP address
26895           required: true
26896           type: string
26897           example: __L3-INTERFACE-IPV4-ADDRESS__
26898         - name: body
26899           in: body
26900           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26901           required: true
26902           schema:
26903             $ref: "#/definitions/l3-interface-ipv4-address-list"
26904     patch:
26905       tags:
26906         - Network
26907       summary: update an existing l3-interface-ipv4-address-list
26908       description: |
26909         Update an existing l3-interface-ipv4-address-list
26910         #
26911         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26912         The PUT operation will entirely replace an existing object.
26913         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.
26914         #
26915         Other differences between PUT and PATCH are:
26916         #
26917         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26918         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26919         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26920       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26921       consumes:
26922         - application/json
26923         - application/xml
26924       produces:
26925         - application/json
26926         - application/xml
26927       responses:
26928         "default":
26929           description: Response codes found in [response codes](https://wiki.onap.org/).
26930       parameters:
26931         - name: equipment-name
26932           in: path
26933           required: true
26934           type: string
26935           example: __EQUIPMENT-NAME__
26936         - name: interface-name
26937           in: path
26938           description: Name that identifies the physical interface
26939           required: true
26940           type: string
26941           example: __INTERFACE-NAME__
26942         - name: interface-name
26943           in: path
26944           description: Name given to the interface
26945           required: true
26946           type: string
26947           example: __INTERFACE-NAME__
26948         - name: l3-interface-ipv4-address
26949           in: path
26950           description: IP address
26951           required: true
26952           type: string
26953           example: __L3-INTERFACE-IPV4-ADDRESS__
26954         - name: body
26955           in: body
26956           description: l3-interface-ipv4-address-list object that needs to be created or updated.
26957           required: true
26958           schema:
26959             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26960     delete:
26961       tags:
26962         - Network
26963       summary: delete an existing l3-interface-ipv4-address-list
26964       description: delete an existing l3-interface-ipv4-address-list
26965       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26966       consumes:
26967         - application/json
26968         - application/xml
26969       produces:
26970         - application/json
26971         - application/xml
26972       responses:
26973         "default":
26974           description: Response codes found in [response codes](https://wiki.onap.org/).
26975       parameters:
26976         - name: equipment-name
26977           in: path
26978           required: true
26979           type: string
26980           example: __EQUIPMENT-NAME__
26981         - name: interface-name
26982           in: path
26983           description: Name that identifies the physical interface
26984           required: true
26985           type: string
26986           example: __INTERFACE-NAME__
26987         - name: interface-name
26988           in: path
26989           description: Name given to the interface
26990           required: true
26991           type: string
26992           example: __INTERFACE-NAME__
26993         - name: l3-interface-ipv4-address
26994           in: path
26995           description: IP address
26996           required: true
26997           type: string
26998           example: __L3-INTERFACE-IPV4-ADDRESS__
26999         - name: resource-version
27000           in: query
27001           description: resource-version for concurrency
27002           required: true
27003           type: string
27004   /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:
27005     put:
27006       tags:
27007         - Network
27008       summary: see node definition for valid relationships
27009       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27010       consumes:
27011         - application/json
27012         - application/xml
27013       produces:
27014         - application/json
27015         - application/xml
27016       responses:
27017         "default":
27018           description: Response codes found in [response codes](https://wiki.onap.org/).
27019       parameters:
27020         - name: equipment-name
27021           in: path
27022           required: true
27023           type: string
27024           example: __EQUIPMENT-NAME__
27025         - name: interface-name
27026           in: path
27027           description: Name that identifies the physical interface
27028           required: true
27029           type: string
27030           example: __INTERFACE-NAME__
27031         - name: interface-name
27032           in: path
27033           description: Name given to the interface
27034           required: true
27035           type: string
27036           example: __INTERFACE-NAME__
27037         - name: l3-interface-ipv6-address
27038           in: path
27039           description: IP address
27040           required: true
27041           type: string
27042           example: __L3-INTERFACE-IPV6-ADDRESS__
27043         - name: body
27044           in: body
27045           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27046           required: true
27047           schema:
27048             $ref: "#/definitions/relationship"
27049     delete:
27050       tags:
27051         - Network
27052       summary: delete an existing relationship
27053       description: delete an existing relationship
27054       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27055       consumes:
27056         - application/json
27057         - application/xml
27058       produces:
27059         - application/json
27060         - application/xml
27061       responses:
27062         "default":
27063           description: Response codes found in [response codes](https://wiki.onap.org/).
27064       parameters:
27065         - name: equipment-name
27066           in: path
27067           required: true
27068           type: string
27069           example: __EQUIPMENT-NAME__
27070         - name: interface-name
27071           in: path
27072           description: Name that identifies the physical interface
27073           required: true
27074           type: string
27075           example: __INTERFACE-NAME__
27076         - name: interface-name
27077           in: path
27078           description: Name given to the interface
27079           required: true
27080           type: string
27081           example: __INTERFACE-NAME__
27082         - name: l3-interface-ipv6-address
27083           in: path
27084           description: IP address
27085           required: true
27086           type: string
27087           example: __L3-INTERFACE-IPV6-ADDRESS__
27088   /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}:
27089     get:
27090       tags:
27091         - Network
27092       summary: returns l3-interface-ipv6-address-list
27093       description: returns l3-interface-ipv6-address-list
27094       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27095       produces:
27096         - application/json
27097         - application/xml
27098       responses:
27099         "200":
27100           description: successful operation
27101           schema:
27102               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
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 physical 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: prov-status
27130           in: query
27131           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27132           required: false
27133           type: string
27134         - name: prov-status
27135           in: query
27136           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27137           required: false
27138           type: string
27139         - name: interface-id
27140           in: query
27141           description: ID of interface
27142           required: false
27143           type: string
27144         - name: macaddr
27145           in: query
27146           description: MAC address for the interface
27147           required: false
27148           type: string
27149         - name: network-name
27150           in: query
27151           description: Name of the network
27152           required: false
27153           type: string
27154         - name: vlan-id-inner
27155           in: query
27156           description: Inner VLAN tag
27157           required: false
27158           type: integer
27159           format: int64
27160         - name: neutron-network-id
27161           in: query
27162           description: Neutron network id of the interface that address belongs to
27163           required: false
27164           type: string
27165         - name: neutron-subnet-id
27166           in: query
27167           description: Neutron id of subnet that address belongs to
27168           required: false
27169           type: string
27170     put:
27171       tags:
27172         - Network
27173       summary: create or update an existing l3-interface-ipv6-address-list
27174       description: |
27175         Create or update an existing l3-interface-ipv6-address-list.
27176         #
27177         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
27178       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27179       consumes:
27180         - application/json
27181         - application/xml
27182       produces:
27183         - application/json
27184         - application/xml
27185       responses:
27186         "default":
27187           description: Response codes found in [response codes](https://wiki.onap.org/).
27188       parameters:
27189         - name: equipment-name
27190           in: path
27191           required: true
27192           type: string
27193           example: __EQUIPMENT-NAME__
27194         - name: interface-name
27195           in: path
27196           description: Name that identifies the physical interface
27197           required: true
27198           type: string
27199           example: __INTERFACE-NAME__
27200         - name: interface-name
27201           in: path
27202           description: Name given to the interface
27203           required: true
27204           type: string
27205           example: __INTERFACE-NAME__
27206         - name: l3-interface-ipv6-address
27207           in: path
27208           description: IP address
27209           required: true
27210           type: string
27211           example: __L3-INTERFACE-IPV6-ADDRESS__
27212         - name: body
27213           in: body
27214           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27215           required: true
27216           schema:
27217             $ref: "#/definitions/l3-interface-ipv6-address-list"
27218     patch:
27219       tags:
27220         - Network
27221       summary: update an existing l3-interface-ipv6-address-list
27222       description: |
27223         Update an existing l3-interface-ipv6-address-list
27224         #
27225         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27226         The PUT operation will entirely replace an existing object.
27227         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.
27228         #
27229         Other differences between PUT and PATCH are:
27230         #
27231         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27232         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27233         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27234       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27235       consumes:
27236         - application/json
27237         - application/xml
27238       produces:
27239         - application/json
27240         - application/xml
27241       responses:
27242         "default":
27243           description: Response codes found in [response codes](https://wiki.onap.org/).
27244       parameters:
27245         - name: equipment-name
27246           in: path
27247           required: true
27248           type: string
27249           example: __EQUIPMENT-NAME__
27250         - name: interface-name
27251           in: path
27252           description: Name that identifies the physical interface
27253           required: true
27254           type: string
27255           example: __INTERFACE-NAME__
27256         - name: interface-name
27257           in: path
27258           description: Name given to the interface
27259           required: true
27260           type: string
27261           example: __INTERFACE-NAME__
27262         - name: l3-interface-ipv6-address
27263           in: path
27264           description: IP address
27265           required: true
27266           type: string
27267           example: __L3-INTERFACE-IPV6-ADDRESS__
27268         - name: body
27269           in: body
27270           description: l3-interface-ipv6-address-list object that needs to be created or updated.
27271           required: true
27272           schema:
27273             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27274     delete:
27275       tags:
27276         - Network
27277       summary: delete an existing l3-interface-ipv6-address-list
27278       description: delete an existing l3-interface-ipv6-address-list
27279       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27280       consumes:
27281         - application/json
27282         - application/xml
27283       produces:
27284         - application/json
27285         - application/xml
27286       responses:
27287         "default":
27288           description: Response codes found in [response codes](https://wiki.onap.org/).
27289       parameters:
27290         - name: equipment-name
27291           in: path
27292           required: true
27293           type: string
27294           example: __EQUIPMENT-NAME__
27295         - name: interface-name
27296           in: path
27297           description: Name that identifies the physical interface
27298           required: true
27299           type: string
27300           example: __INTERFACE-NAME__
27301         - name: interface-name
27302           in: path
27303           description: Name given to the interface
27304           required: true
27305           type: string
27306           example: __INTERFACE-NAME__
27307         - name: l3-interface-ipv6-address
27308           in: path
27309           description: IP address
27310           required: true
27311           type: string
27312           example: __L3-INTERFACE-IPV6-ADDRESS__
27313         - name: resource-version
27314           in: query
27315           description: resource-version for concurrency
27316           required: true
27317           type: string
27318   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
27319     get:
27320       tags:
27321         - Network
27322       summary: returns l-interface
27323       description: returns l-interface
27324       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27325       produces:
27326         - application/json
27327         - application/xml
27328       responses:
27329         "200":
27330           description: successful operation
27331           schema:
27332               $ref: "#/getDefinitions/l-interface"
27333         "default":
27334           description: Response codes found in [response codes](https://wiki.onap.org/).
27335       parameters:
27336         - name: equipment-name
27337           in: path
27338           required: true
27339           type: string
27340           example: __EQUIPMENT-NAME__
27341         - name: interface-name
27342           in: path
27343           description: Name that identifies the physical interface
27344           required: true
27345           type: string
27346           example: __INTERFACE-NAME__
27347         - name: interface-name
27348           in: path
27349           description: Name given to the interface
27350           required: true
27351           type: string
27352           example: __INTERFACE-NAME__
27353         - name: prov-status
27354           in: query
27355           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27356           required: false
27357           type: string
27358         - name: prov-status
27359           in: query
27360           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27361           required: false
27362           type: string
27363         - name: interface-id
27364           in: query
27365           description: ID of interface
27366           required: false
27367           type: string
27368         - name: macaddr
27369           in: query
27370           description: MAC address for the interface
27371           required: false
27372           type: string
27373         - name: network-name
27374           in: query
27375           description: Name of the network
27376           required: false
27377           type: string
27378     put:
27379       tags:
27380         - Network
27381       summary: create or update an existing l-interface
27382       description: |
27383         Create or update an existing l-interface.
27384         #
27385         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
27386       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27387       consumes:
27388         - application/json
27389         - application/xml
27390       produces:
27391         - application/json
27392         - application/xml
27393       responses:
27394         "default":
27395           description: Response codes found in [response codes](https://wiki.onap.org/).
27396       parameters:
27397         - name: equipment-name
27398           in: path
27399           required: true
27400           type: string
27401           example: __EQUIPMENT-NAME__
27402         - name: interface-name
27403           in: path
27404           description: Name that identifies the physical interface
27405           required: true
27406           type: string
27407           example: __INTERFACE-NAME__
27408         - name: interface-name
27409           in: path
27410           description: Name given to the interface
27411           required: true
27412           type: string
27413           example: __INTERFACE-NAME__
27414         - name: body
27415           in: body
27416           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
27417           required: true
27418           schema:
27419             $ref: "#/definitions/l-interface"
27420     patch:
27421       tags:
27422         - Network
27423       summary: update an existing l-interface
27424       description: |
27425         Update an existing l-interface
27426         #
27427         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27428         The PUT operation will entirely replace an existing object.
27429         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.
27430         #
27431         Other differences between PUT and PATCH are:
27432         #
27433         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27434         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27435         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27436       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27437       consumes:
27438         - application/json
27439         - application/xml
27440       produces:
27441         - application/json
27442         - application/xml
27443       responses:
27444         "default":
27445           description: Response codes found in [response codes](https://wiki.onap.org/).
27446       parameters:
27447         - name: equipment-name
27448           in: path
27449           required: true
27450           type: string
27451           example: __EQUIPMENT-NAME__
27452         - name: interface-name
27453           in: path
27454           description: Name that identifies the physical interface
27455           required: true
27456           type: string
27457           example: __INTERFACE-NAME__
27458         - name: interface-name
27459           in: path
27460           description: Name given to the interface
27461           required: true
27462           type: string
27463           example: __INTERFACE-NAME__
27464         - name: body
27465           in: body
27466           description: l-interface object that needs to be created or updated.
27467           required: true
27468           schema:
27469             $ref: "#/patchDefinitions/l-interface"
27470     delete:
27471       tags:
27472         - Network
27473       summary: delete an existing l-interface
27474       description: delete an existing l-interface
27475       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
27476       consumes:
27477         - application/json
27478         - application/xml
27479       produces:
27480         - application/json
27481         - application/xml
27482       responses:
27483         "default":
27484           description: Response codes found in [response codes](https://wiki.onap.org/).
27485       parameters:
27486         - name: equipment-name
27487           in: path
27488           required: true
27489           type: string
27490           example: __EQUIPMENT-NAME__
27491         - name: interface-name
27492           in: path
27493           description: Name that identifies the physical interface
27494           required: true
27495           type: string
27496           example: __INTERFACE-NAME__
27497         - name: interface-name
27498           in: path
27499           description: Name given to the interface
27500           required: true
27501           type: string
27502           example: __INTERFACE-NAME__
27503         - name: resource-version
27504           in: query
27505           description: resource-version for concurrency
27506           required: true
27507           type: string
27508   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
27509     get:
27510       tags:
27511         - Network
27512       summary: returns l-interfaces
27513       description: returns l-interfaces
27514       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
27515       produces:
27516         - application/json
27517         - application/xml
27518       responses:
27519         "200":
27520           description: successful operation
27521           schema:
27522               $ref: "#/getDefinitions/l-interfaces"
27523         "default":
27524           description: Response codes found in [response codes](https://wiki.onap.org/).
27525       parameters:
27526         - name: equipment-name
27527           in: path
27528           required: true
27529           type: string
27530           example: __EQUIPMENT-NAME__
27531         - name: interface-name
27532           in: path
27533           description: Name that identifies the physical interface
27534           required: true
27535           type: string
27536           example: __INTERFACE-NAME__
27537         - name: prov-status
27538           in: query
27539           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27540           required: false
27541           type: string
27542         - name: prov-status
27543           in: query
27544           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27545           required: false
27546           type: string
27547   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
27548     get:
27549       tags:
27550         - Network
27551       summary: returns p-interface
27552       description: returns p-interface
27553       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
27554       produces:
27555         - application/json
27556         - application/xml
27557       responses:
27558         "200":
27559           description: successful operation
27560           schema:
27561               $ref: "#/getDefinitions/p-interface"
27562         "default":
27563           description: Response codes found in [response codes](https://wiki.onap.org/).
27564       parameters:
27565         - name: equipment-name
27566           in: path
27567           required: true
27568           type: string
27569           example: __EQUIPMENT-NAME__
27570         - name: interface-name
27571           in: path
27572           description: Name that identifies the physical interface
27573           required: true
27574           type: string
27575           example: __INTERFACE-NAME__
27576         - name: prov-status
27577           in: query
27578           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27579           required: false
27580           type: string
27581         - name: prov-status
27582           in: query
27583           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27584           required: false
27585           type: string
27586     put:
27587       tags:
27588         - Network
27589       summary: create or update an existing p-interface
27590       description: |
27591         Create or update an existing p-interface.
27592         #
27593         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
27594       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
27595       consumes:
27596         - application/json
27597         - application/xml
27598       produces:
27599         - application/json
27600         - application/xml
27601       responses:
27602         "default":
27603           description: Response codes found in [response codes](https://wiki.onap.org/).
27604       parameters:
27605         - name: equipment-name
27606           in: path
27607           required: true
27608           type: string
27609           example: __EQUIPMENT-NAME__
27610         - name: interface-name
27611           in: path
27612           description: Name that identifies the physical interface
27613           required: true
27614           type: string
27615           example: __INTERFACE-NAME__
27616         - name: body
27617           in: body
27618           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
27619           required: true
27620           schema:
27621             $ref: "#/definitions/p-interface"
27622     patch:
27623       tags:
27624         - Network
27625       summary: update an existing p-interface
27626       description: |
27627         Update an existing p-interface
27628         #
27629         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27630         The PUT operation will entirely replace an existing object.
27631         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.
27632         #
27633         Other differences between PUT and PATCH are:
27634         #
27635         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27636         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27637         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27638       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
27639       consumes:
27640         - application/json
27641         - application/xml
27642       produces:
27643         - application/json
27644         - application/xml
27645       responses:
27646         "default":
27647           description: Response codes found in [response codes](https://wiki.onap.org/).
27648       parameters:
27649         - name: equipment-name
27650           in: path
27651           required: true
27652           type: string
27653           example: __EQUIPMENT-NAME__
27654         - name: interface-name
27655           in: path
27656           description: Name that identifies the physical interface
27657           required: true
27658           type: string
27659           example: __INTERFACE-NAME__
27660         - name: body
27661           in: body
27662           description: p-interface object that needs to be created or updated.
27663           required: true
27664           schema:
27665             $ref: "#/patchDefinitions/p-interface"
27666     delete:
27667       tags:
27668         - Network
27669       summary: delete an existing p-interface
27670       description: delete an existing p-interface
27671       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
27672       consumes:
27673         - application/json
27674         - application/xml
27675       produces:
27676         - application/json
27677         - application/xml
27678       responses:
27679         "default":
27680           description: Response codes found in [response codes](https://wiki.onap.org/).
27681       parameters:
27682         - name: equipment-name
27683           in: path
27684           required: true
27685           type: string
27686           example: __EQUIPMENT-NAME__
27687         - name: interface-name
27688           in: path
27689           description: Name that identifies the physical interface
27690           required: true
27691           type: string
27692           example: __INTERFACE-NAME__
27693         - name: resource-version
27694           in: query
27695           description: resource-version for concurrency
27696           required: true
27697           type: string
27698   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
27699     get:
27700       tags:
27701         - Network
27702       summary: returns p-interfaces
27703       description: returns p-interfaces
27704       operationId: getNetworkVplsPesVplsPePInterfaces
27705       produces:
27706         - application/json
27707         - application/xml
27708       responses:
27709         "200":
27710           description: successful operation
27711           schema:
27712               $ref: "#/getDefinitions/p-interfaces"
27713         "default":
27714           description: Response codes found in [response codes](https://wiki.onap.org/).
27715       parameters:
27716         - name: equipment-name
27717           in: path
27718           required: true
27719           type: string
27720           example: __EQUIPMENT-NAME__
27721         - name: prov-status
27722           in: query
27723           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27724           required: false
27725           type: string
27726   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
27727     put:
27728       tags:
27729         - Network
27730       summary: see node definition for valid relationships
27731       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
27732       consumes:
27733         - application/json
27734         - application/xml
27735       produces:
27736         - application/json
27737         - application/xml
27738       responses:
27739         "default":
27740           description: Response codes found in [response codes](https://wiki.onap.org/).
27741       parameters:
27742         - name: equipment-name
27743           in: path
27744           required: true
27745           type: string
27746           example: __EQUIPMENT-NAME__
27747         - name: interface-name
27748           in: path
27749           description: Name that identifies the link aggregate interface
27750           required: true
27751           type: string
27752           example: __INTERFACE-NAME__
27753         - name: body
27754           in: body
27755           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27756           required: true
27757           schema:
27758             $ref: "#/definitions/relationship"
27759     delete:
27760       tags:
27761         - Network
27762       summary: delete an existing relationship
27763       description: delete an existing relationship
27764       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
27765       consumes:
27766         - application/json
27767         - application/xml
27768       produces:
27769         - application/json
27770         - application/xml
27771       responses:
27772         "default":
27773           description: Response codes found in [response codes](https://wiki.onap.org/).
27774       parameters:
27775         - name: equipment-name
27776           in: path
27777           required: true
27778           type: string
27779           example: __EQUIPMENT-NAME__
27780         - name: interface-name
27781           in: path
27782           description: Name that identifies the link aggregate interface
27783           required: true
27784           type: string
27785           example: __INTERFACE-NAME__
27786   /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:
27787     put:
27788       tags:
27789         - Network
27790       summary: see node definition for valid relationships
27791       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27792       consumes:
27793         - application/json
27794         - application/xml
27795       produces:
27796         - application/json
27797         - application/xml
27798       responses:
27799         "default":
27800           description: Response codes found in [response codes](https://wiki.onap.org/).
27801       parameters:
27802         - name: equipment-name
27803           in: path
27804           required: true
27805           type: string
27806           example: __EQUIPMENT-NAME__
27807         - name: interface-name
27808           in: path
27809           description: Name that identifies the link aggregate interface
27810           required: true
27811           type: string
27812           example: __INTERFACE-NAME__
27813         - name: interface-name
27814           in: path
27815           description: Name given to the interface
27816           required: true
27817           type: string
27818           example: __INTERFACE-NAME__
27819         - name: vlan-interface
27820           in: path
27821           description: String that identifies the interface
27822           required: true
27823           type: string
27824           example: __VLAN-INTERFACE__
27825         - name: body
27826           in: body
27827           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
27828           required: true
27829           schema:
27830             $ref: "#/definitions/relationship"
27831     delete:
27832       tags:
27833         - Network
27834       summary: delete an existing relationship
27835       description: delete an existing relationship
27836       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27837       consumes:
27838         - application/json
27839         - application/xml
27840       produces:
27841         - application/json
27842         - application/xml
27843       responses:
27844         "default":
27845           description: Response codes found in [response codes](https://wiki.onap.org/).
27846       parameters:
27847         - name: equipment-name
27848           in: path
27849           required: true
27850           type: string
27851           example: __EQUIPMENT-NAME__
27852         - name: interface-name
27853           in: path
27854           description: Name that identifies the link aggregate interface
27855           required: true
27856           type: string
27857           example: __INTERFACE-NAME__
27858         - name: interface-name
27859           in: path
27860           description: Name given to the interface
27861           required: true
27862           type: string
27863           example: __INTERFACE-NAME__
27864         - name: vlan-interface
27865           in: path
27866           description: String that identifies the interface
27867           required: true
27868           type: string
27869           example: __VLAN-INTERFACE__
27870   /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:
27871     put:
27872       tags:
27873         - Network
27874       summary: see node definition for valid relationships
27875       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27876       consumes:
27877         - application/json
27878         - application/xml
27879       produces:
27880         - application/json
27881         - application/xml
27882       responses:
27883         "default":
27884           description: Response codes found in [response codes](https://wiki.onap.org/).
27885       parameters:
27886         - name: equipment-name
27887           in: path
27888           required: true
27889           type: string
27890           example: __EQUIPMENT-NAME__
27891         - name: interface-name
27892           in: path
27893           description: Name that identifies the link aggregate interface
27894           required: true
27895           type: string
27896           example: __INTERFACE-NAME__
27897         - name: interface-name
27898           in: path
27899           description: Name given to the interface
27900           required: true
27901           type: string
27902           example: __INTERFACE-NAME__
27903         - name: vlan-interface
27904           in: path
27905           description: String that identifies the interface
27906           required: true
27907           type: string
27908           example: __VLAN-INTERFACE__
27909         - name: l3-interface-ipv4-address
27910           in: path
27911           description: IP address
27912           required: true
27913           type: string
27914           example: __L3-INTERFACE-IPV4-ADDRESS__
27915         - name: body
27916           in: body
27917           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27918           required: true
27919           schema:
27920             $ref: "#/definitions/relationship"
27921     delete:
27922       tags:
27923         - Network
27924       summary: delete an existing relationship
27925       description: delete an existing relationship
27926       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27927       consumes:
27928         - application/json
27929         - application/xml
27930       produces:
27931         - application/json
27932         - application/xml
27933       responses:
27934         "default":
27935           description: Response codes found in [response codes](https://wiki.onap.org/).
27936       parameters:
27937         - name: equipment-name
27938           in: path
27939           required: true
27940           type: string
27941           example: __EQUIPMENT-NAME__
27942         - name: interface-name
27943           in: path
27944           description: Name that identifies the link aggregate interface
27945           required: true
27946           type: string
27947           example: __INTERFACE-NAME__
27948         - name: interface-name
27949           in: path
27950           description: Name given to the interface
27951           required: true
27952           type: string
27953           example: __INTERFACE-NAME__
27954         - name: vlan-interface
27955           in: path
27956           description: String that identifies the interface
27957           required: true
27958           type: string
27959           example: __VLAN-INTERFACE__
27960         - name: l3-interface-ipv4-address
27961           in: path
27962           description: IP address
27963           required: true
27964           type: string
27965           example: __L3-INTERFACE-IPV4-ADDRESS__
27966   /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}:
27967     get:
27968       tags:
27969         - Network
27970       summary: returns l3-interface-ipv4-address-list
27971       description: returns l3-interface-ipv4-address-list
27972       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27973       produces:
27974         - application/json
27975         - application/xml
27976       responses:
27977         "200":
27978           description: successful operation
27979           schema:
27980               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27981         "default":
27982           description: Response codes found in [response codes](https://wiki.onap.org/).
27983       parameters:
27984         - name: equipment-name
27985           in: path
27986           required: true
27987           type: string
27988           example: __EQUIPMENT-NAME__
27989         - name: interface-name
27990           in: path
27991           description: Name that identifies the link aggregate interface
27992           required: true
27993           type: string
27994           example: __INTERFACE-NAME__
27995         - name: interface-name
27996           in: path
27997           description: Name given to the interface
27998           required: true
27999           type: string
28000           example: __INTERFACE-NAME__
28001         - name: vlan-interface
28002           in: path
28003           description: String that identifies the interface
28004           required: true
28005           type: string
28006           example: __VLAN-INTERFACE__
28007         - name: l3-interface-ipv4-address
28008           in: path
28009           description: IP address
28010           required: true
28011           type: string
28012           example: __L3-INTERFACE-IPV4-ADDRESS__
28013         - name: prov-status
28014           in: query
28015           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28016           required: false
28017           type: string
28018         - name: interface-id
28019           in: query
28020           description: ID of interface
28021           required: false
28022           type: string
28023         - name: interface-role
28024           in: query
28025           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28026           required: false
28027           type: string
28028         - name: interface-id
28029           in: query
28030           description: ID of interface
28031           required: false
28032           type: string
28033         - name: macaddr
28034           in: query
28035           description: MAC address for the interface
28036           required: false
28037           type: string
28038         - name: network-name
28039           in: query
28040           description: Name of the network
28041           required: false
28042           type: string
28043         - name: vlan-id-inner
28044           in: query
28045           description: Inner VLAN tag
28046           required: false
28047           type: integer
28048           format: int64
28049         - name: vpn-key
28050           in: query
28051           description: This indicates the customers VPN ID associated with this vlan
28052           required: false
28053           type: string
28054         - name: vlan-id-inner
28055           in: query
28056           description: Inner VLAN tag
28057           required: false
28058           type: integer
28059           format: int64
28060         - name: neutron-network-id
28061           in: query
28062           description: Neutron network id of the interface that address belongs to
28063           required: false
28064           type: string
28065         - name: neutron-subnet-id
28066           in: query
28067           description: Neutron id of subnet that address belongs to
28068           required: false
28069           type: string
28070     put:
28071       tags:
28072         - Network
28073       summary: create or update an existing l3-interface-ipv4-address-list
28074       description: |
28075         Create or update an existing l3-interface-ipv4-address-list.
28076         #
28077         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
28078       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28079       consumes:
28080         - application/json
28081         - application/xml
28082       produces:
28083         - application/json
28084         - application/xml
28085       responses:
28086         "default":
28087           description: Response codes found in [response codes](https://wiki.onap.org/).
28088       parameters:
28089         - name: equipment-name
28090           in: path
28091           required: true
28092           type: string
28093           example: __EQUIPMENT-NAME__
28094         - name: interface-name
28095           in: path
28096           description: Name that identifies the link aggregate interface
28097           required: true
28098           type: string
28099           example: __INTERFACE-NAME__
28100         - name: interface-name
28101           in: path
28102           description: Name given to the interface
28103           required: true
28104           type: string
28105           example: __INTERFACE-NAME__
28106         - name: vlan-interface
28107           in: path
28108           description: String that identifies the interface
28109           required: true
28110           type: string
28111           example: __VLAN-INTERFACE__
28112         - name: l3-interface-ipv4-address
28113           in: path
28114           description: IP address
28115           required: true
28116           type: string
28117           example: __L3-INTERFACE-IPV4-ADDRESS__
28118         - name: body
28119           in: body
28120           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28121           required: true
28122           schema:
28123             $ref: "#/definitions/l3-interface-ipv4-address-list"
28124     patch:
28125       tags:
28126         - Network
28127       summary: update an existing l3-interface-ipv4-address-list
28128       description: |
28129         Update an existing l3-interface-ipv4-address-list
28130         #
28131         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28132         The PUT operation will entirely replace an existing object.
28133         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.
28134         #
28135         Other differences between PUT and PATCH are:
28136         #
28137         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28138         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28139         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28140       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28141       consumes:
28142         - application/json
28143         - application/xml
28144       produces:
28145         - application/json
28146         - application/xml
28147       responses:
28148         "default":
28149           description: Response codes found in [response codes](https://wiki.onap.org/).
28150       parameters:
28151         - name: equipment-name
28152           in: path
28153           required: true
28154           type: string
28155           example: __EQUIPMENT-NAME__
28156         - name: interface-name
28157           in: path
28158           description: Name that identifies the link aggregate interface
28159           required: true
28160           type: string
28161           example: __INTERFACE-NAME__
28162         - name: interface-name
28163           in: path
28164           description: Name given to the interface
28165           required: true
28166           type: string
28167           example: __INTERFACE-NAME__
28168         - name: vlan-interface
28169           in: path
28170           description: String that identifies the interface
28171           required: true
28172           type: string
28173           example: __VLAN-INTERFACE__
28174         - name: l3-interface-ipv4-address
28175           in: path
28176           description: IP address
28177           required: true
28178           type: string
28179           example: __L3-INTERFACE-IPV4-ADDRESS__
28180         - name: body
28181           in: body
28182           description: l3-interface-ipv4-address-list object that needs to be created or updated.
28183           required: true
28184           schema:
28185             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28186     delete:
28187       tags:
28188         - Network
28189       summary: delete an existing l3-interface-ipv4-address-list
28190       description: delete an existing l3-interface-ipv4-address-list
28191       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28192       consumes:
28193         - application/json
28194         - application/xml
28195       produces:
28196         - application/json
28197         - application/xml
28198       responses:
28199         "default":
28200           description: Response codes found in [response codes](https://wiki.onap.org/).
28201       parameters:
28202         - name: equipment-name
28203           in: path
28204           required: true
28205           type: string
28206           example: __EQUIPMENT-NAME__
28207         - name: interface-name
28208           in: path
28209           description: Name that identifies the link aggregate interface
28210           required: true
28211           type: string
28212           example: __INTERFACE-NAME__
28213         - name: interface-name
28214           in: path
28215           description: Name given to the interface
28216           required: true
28217           type: string
28218           example: __INTERFACE-NAME__
28219         - name: vlan-interface
28220           in: path
28221           description: String that identifies the interface
28222           required: true
28223           type: string
28224           example: __VLAN-INTERFACE__
28225         - name: l3-interface-ipv4-address
28226           in: path
28227           description: IP address
28228           required: true
28229           type: string
28230           example: __L3-INTERFACE-IPV4-ADDRESS__
28231         - name: resource-version
28232           in: query
28233           description: resource-version for concurrency
28234           required: true
28235           type: string
28236   /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:
28237     put:
28238       tags:
28239         - Network
28240       summary: see node definition for valid relationships
28241       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28242       consumes:
28243         - application/json
28244         - application/xml
28245       produces:
28246         - application/json
28247         - application/xml
28248       responses:
28249         "default":
28250           description: Response codes found in [response codes](https://wiki.onap.org/).
28251       parameters:
28252         - name: equipment-name
28253           in: path
28254           required: true
28255           type: string
28256           example: __EQUIPMENT-NAME__
28257         - name: interface-name
28258           in: path
28259           description: Name that identifies the link aggregate interface
28260           required: true
28261           type: string
28262           example: __INTERFACE-NAME__
28263         - name: interface-name
28264           in: path
28265           description: Name given to the interface
28266           required: true
28267           type: string
28268           example: __INTERFACE-NAME__
28269         - name: vlan-interface
28270           in: path
28271           description: String that identifies the interface
28272           required: true
28273           type: string
28274           example: __VLAN-INTERFACE__
28275         - name: l3-interface-ipv6-address
28276           in: path
28277           description: IP address
28278           required: true
28279           type: string
28280           example: __L3-INTERFACE-IPV6-ADDRESS__
28281         - name: body
28282           in: body
28283           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28284           required: true
28285           schema:
28286             $ref: "#/definitions/relationship"
28287     delete:
28288       tags:
28289         - Network
28290       summary: delete an existing relationship
28291       description: delete an existing relationship
28292       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28293       consumes:
28294         - application/json
28295         - application/xml
28296       produces:
28297         - application/json
28298         - application/xml
28299       responses:
28300         "default":
28301           description: Response codes found in [response codes](https://wiki.onap.org/).
28302       parameters:
28303         - name: equipment-name
28304           in: path
28305           required: true
28306           type: string
28307           example: __EQUIPMENT-NAME__
28308         - name: interface-name
28309           in: path
28310           description: Name that identifies the link aggregate interface
28311           required: true
28312           type: string
28313           example: __INTERFACE-NAME__
28314         - name: interface-name
28315           in: path
28316           description: Name given to the interface
28317           required: true
28318           type: string
28319           example: __INTERFACE-NAME__
28320         - name: vlan-interface
28321           in: path
28322           description: String that identifies the interface
28323           required: true
28324           type: string
28325           example: __VLAN-INTERFACE__
28326         - name: l3-interface-ipv6-address
28327           in: path
28328           description: IP address
28329           required: true
28330           type: string
28331           example: __L3-INTERFACE-IPV6-ADDRESS__
28332   /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}:
28333     get:
28334       tags:
28335         - Network
28336       summary: returns l3-interface-ipv6-address-list
28337       description: returns l3-interface-ipv6-address-list
28338       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28339       produces:
28340         - application/json
28341         - application/xml
28342       responses:
28343         "200":
28344           description: successful operation
28345           schema:
28346               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28347         "default":
28348           description: Response codes found in [response codes](https://wiki.onap.org/).
28349       parameters:
28350         - name: equipment-name
28351           in: path
28352           required: true
28353           type: string
28354           example: __EQUIPMENT-NAME__
28355         - name: interface-name
28356           in: path
28357           description: Name that identifies the link aggregate interface
28358           required: true
28359           type: string
28360           example: __INTERFACE-NAME__
28361         - name: interface-name
28362           in: path
28363           description: Name given to the interface
28364           required: true
28365           type: string
28366           example: __INTERFACE-NAME__
28367         - name: vlan-interface
28368           in: path
28369           description: String that identifies the interface
28370           required: true
28371           type: string
28372           example: __VLAN-INTERFACE__
28373         - name: l3-interface-ipv6-address
28374           in: path
28375           description: IP address
28376           required: true
28377           type: string
28378           example: __L3-INTERFACE-IPV6-ADDRESS__
28379         - name: prov-status
28380           in: query
28381           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28382           required: false
28383           type: string
28384         - name: interface-id
28385           in: query
28386           description: ID of interface
28387           required: false
28388           type: string
28389         - name: interface-role
28390           in: query
28391           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28392           required: false
28393           type: string
28394         - name: interface-id
28395           in: query
28396           description: ID of interface
28397           required: false
28398           type: string
28399         - name: macaddr
28400           in: query
28401           description: MAC address for the interface
28402           required: false
28403           type: string
28404         - name: network-name
28405           in: query
28406           description: Name of the network
28407           required: false
28408           type: string
28409         - name: vlan-id-inner
28410           in: query
28411           description: Inner VLAN tag
28412           required: false
28413           type: integer
28414           format: int64
28415         - name: vpn-key
28416           in: query
28417           description: This indicates the customers VPN ID associated with this vlan
28418           required: false
28419           type: string
28420         - name: vlan-id-inner
28421           in: query
28422           description: Inner VLAN tag
28423           required: false
28424           type: integer
28425           format: int64
28426         - name: neutron-network-id
28427           in: query
28428           description: Neutron network id of the interface that address belongs to
28429           required: false
28430           type: string
28431         - name: neutron-subnet-id
28432           in: query
28433           description: Neutron id of subnet that address belongs to
28434           required: false
28435           type: string
28436     put:
28437       tags:
28438         - Network
28439       summary: create or update an existing l3-interface-ipv6-address-list
28440       description: |
28441         Create or update an existing l3-interface-ipv6-address-list.
28442         #
28443         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
28444       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28445       consumes:
28446         - application/json
28447         - application/xml
28448       produces:
28449         - application/json
28450         - application/xml
28451       responses:
28452         "default":
28453           description: Response codes found in [response codes](https://wiki.onap.org/).
28454       parameters:
28455         - name: equipment-name
28456           in: path
28457           required: true
28458           type: string
28459           example: __EQUIPMENT-NAME__
28460         - name: interface-name
28461           in: path
28462           description: Name that identifies the link aggregate interface
28463           required: true
28464           type: string
28465           example: __INTERFACE-NAME__
28466         - name: interface-name
28467           in: path
28468           description: Name given to the interface
28469           required: true
28470           type: string
28471           example: __INTERFACE-NAME__
28472         - name: vlan-interface
28473           in: path
28474           description: String that identifies the interface
28475           required: true
28476           type: string
28477           example: __VLAN-INTERFACE__
28478         - name: l3-interface-ipv6-address
28479           in: path
28480           description: IP address
28481           required: true
28482           type: string
28483           example: __L3-INTERFACE-IPV6-ADDRESS__
28484         - name: body
28485           in: body
28486           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28487           required: true
28488           schema:
28489             $ref: "#/definitions/l3-interface-ipv6-address-list"
28490     patch:
28491       tags:
28492         - Network
28493       summary: update an existing l3-interface-ipv6-address-list
28494       description: |
28495         Update an existing l3-interface-ipv6-address-list
28496         #
28497         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28498         The PUT operation will entirely replace an existing object.
28499         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.
28500         #
28501         Other differences between PUT and PATCH are:
28502         #
28503         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28504         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28505         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28506       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28507       consumes:
28508         - application/json
28509         - application/xml
28510       produces:
28511         - application/json
28512         - application/xml
28513       responses:
28514         "default":
28515           description: Response codes found in [response codes](https://wiki.onap.org/).
28516       parameters:
28517         - name: equipment-name
28518           in: path
28519           required: true
28520           type: string
28521           example: __EQUIPMENT-NAME__
28522         - name: interface-name
28523           in: path
28524           description: Name that identifies the link aggregate interface
28525           required: true
28526           type: string
28527           example: __INTERFACE-NAME__
28528         - name: interface-name
28529           in: path
28530           description: Name given to the interface
28531           required: true
28532           type: string
28533           example: __INTERFACE-NAME__
28534         - name: vlan-interface
28535           in: path
28536           description: String that identifies the interface
28537           required: true
28538           type: string
28539           example: __VLAN-INTERFACE__
28540         - name: l3-interface-ipv6-address
28541           in: path
28542           description: IP address
28543           required: true
28544           type: string
28545           example: __L3-INTERFACE-IPV6-ADDRESS__
28546         - name: body
28547           in: body
28548           description: l3-interface-ipv6-address-list object that needs to be created or updated.
28549           required: true
28550           schema:
28551             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28552     delete:
28553       tags:
28554         - Network
28555       summary: delete an existing l3-interface-ipv6-address-list
28556       description: delete an existing l3-interface-ipv6-address-list
28557       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28558       consumes:
28559         - application/json
28560         - application/xml
28561       produces:
28562         - application/json
28563         - application/xml
28564       responses:
28565         "default":
28566           description: Response codes found in [response codes](https://wiki.onap.org/).
28567       parameters:
28568         - name: equipment-name
28569           in: path
28570           required: true
28571           type: string
28572           example: __EQUIPMENT-NAME__
28573         - name: interface-name
28574           in: path
28575           description: Name that identifies the link aggregate interface
28576           required: true
28577           type: string
28578           example: __INTERFACE-NAME__
28579         - name: interface-name
28580           in: path
28581           description: Name given to the interface
28582           required: true
28583           type: string
28584           example: __INTERFACE-NAME__
28585         - name: vlan-interface
28586           in: path
28587           description: String that identifies the interface
28588           required: true
28589           type: string
28590           example: __VLAN-INTERFACE__
28591         - name: l3-interface-ipv6-address
28592           in: path
28593           description: IP address
28594           required: true
28595           type: string
28596           example: __L3-INTERFACE-IPV6-ADDRESS__
28597         - name: resource-version
28598           in: query
28599           description: resource-version for concurrency
28600           required: true
28601           type: string
28602   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28603     get:
28604       tags:
28605         - Network
28606       summary: returns vlan
28607       description: returns vlan
28608       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28609       produces:
28610         - application/json
28611         - application/xml
28612       responses:
28613         "200":
28614           description: successful operation
28615           schema:
28616               $ref: "#/getDefinitions/vlan"
28617         "default":
28618           description: Response codes found in [response codes](https://wiki.onap.org/).
28619       parameters:
28620         - name: equipment-name
28621           in: path
28622           required: true
28623           type: string
28624           example: __EQUIPMENT-NAME__
28625         - name: interface-name
28626           in: path
28627           description: Name that identifies the link aggregate interface
28628           required: true
28629           type: string
28630           example: __INTERFACE-NAME__
28631         - name: interface-name
28632           in: path
28633           description: Name given to the interface
28634           required: true
28635           type: string
28636           example: __INTERFACE-NAME__
28637         - name: vlan-interface
28638           in: path
28639           description: String that identifies the interface
28640           required: true
28641           type: string
28642           example: __VLAN-INTERFACE__
28643         - name: prov-status
28644           in: query
28645           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28646           required: false
28647           type: string
28648         - name: interface-id
28649           in: query
28650           description: ID of interface
28651           required: false
28652           type: string
28653         - name: interface-role
28654           in: query
28655           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28656           required: false
28657           type: string
28658         - name: interface-id
28659           in: query
28660           description: ID of interface
28661           required: false
28662           type: string
28663         - name: macaddr
28664           in: query
28665           description: MAC address for the interface
28666           required: false
28667           type: string
28668         - name: network-name
28669           in: query
28670           description: Name of the network
28671           required: false
28672           type: string
28673         - name: vlan-id-inner
28674           in: query
28675           description: Inner VLAN tag
28676           required: false
28677           type: integer
28678           format: int64
28679         - name: vpn-key
28680           in: query
28681           description: This indicates the customers VPN ID associated with this vlan
28682           required: false
28683           type: string
28684     put:
28685       tags:
28686         - Network
28687       summary: create or update an existing vlan
28688       description: |
28689         Create or update an existing vlan.
28690         #
28691         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
28692       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28693       consumes:
28694         - application/json
28695         - application/xml
28696       produces:
28697         - application/json
28698         - application/xml
28699       responses:
28700         "default":
28701           description: Response codes found in [response codes](https://wiki.onap.org/).
28702       parameters:
28703         - name: equipment-name
28704           in: path
28705           required: true
28706           type: string
28707           example: __EQUIPMENT-NAME__
28708         - name: interface-name
28709           in: path
28710           description: Name that identifies the link aggregate interface
28711           required: true
28712           type: string
28713           example: __INTERFACE-NAME__
28714         - name: interface-name
28715           in: path
28716           description: Name given to the interface
28717           required: true
28718           type: string
28719           example: __INTERFACE-NAME__
28720         - name: vlan-interface
28721           in: path
28722           description: String that identifies the interface
28723           required: true
28724           type: string
28725           example: __VLAN-INTERFACE__
28726         - name: body
28727           in: body
28728           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
28729           required: true
28730           schema:
28731             $ref: "#/definitions/vlan"
28732     patch:
28733       tags:
28734         - Network
28735       summary: update an existing vlan
28736       description: |
28737         Update an existing vlan
28738         #
28739         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28740         The PUT operation will entirely replace an existing object.
28741         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.
28742         #
28743         Other differences between PUT and PATCH are:
28744         #
28745         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28746         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28747         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28748       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28749       consumes:
28750         - application/json
28751         - application/xml
28752       produces:
28753         - application/json
28754         - application/xml
28755       responses:
28756         "default":
28757           description: Response codes found in [response codes](https://wiki.onap.org/).
28758       parameters:
28759         - name: equipment-name
28760           in: path
28761           required: true
28762           type: string
28763           example: __EQUIPMENT-NAME__
28764         - name: interface-name
28765           in: path
28766           description: Name that identifies the link aggregate interface
28767           required: true
28768           type: string
28769           example: __INTERFACE-NAME__
28770         - name: interface-name
28771           in: path
28772           description: Name given to the interface
28773           required: true
28774           type: string
28775           example: __INTERFACE-NAME__
28776         - name: vlan-interface
28777           in: path
28778           description: String that identifies the interface
28779           required: true
28780           type: string
28781           example: __VLAN-INTERFACE__
28782         - name: body
28783           in: body
28784           description: vlan object that needs to be created or updated.
28785           required: true
28786           schema:
28787             $ref: "#/patchDefinitions/vlan"
28788     delete:
28789       tags:
28790         - Network
28791       summary: delete an existing vlan
28792       description: delete an existing vlan
28793       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
28794       consumes:
28795         - application/json
28796         - application/xml
28797       produces:
28798         - application/json
28799         - application/xml
28800       responses:
28801         "default":
28802           description: Response codes found in [response codes](https://wiki.onap.org/).
28803       parameters:
28804         - name: equipment-name
28805           in: path
28806           required: true
28807           type: string
28808           example: __EQUIPMENT-NAME__
28809         - name: interface-name
28810           in: path
28811           description: Name that identifies the link aggregate interface
28812           required: true
28813           type: string
28814           example: __INTERFACE-NAME__
28815         - name: interface-name
28816           in: path
28817           description: Name given to the interface
28818           required: true
28819           type: string
28820           example: __INTERFACE-NAME__
28821         - name: vlan-interface
28822           in: path
28823           description: String that identifies the interface
28824           required: true
28825           type: string
28826           example: __VLAN-INTERFACE__
28827         - name: resource-version
28828           in: query
28829           description: resource-version for concurrency
28830           required: true
28831           type: string
28832   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
28833     get:
28834       tags:
28835         - Network
28836       summary: returns vlans
28837       description: returns vlans
28838       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
28839       produces:
28840         - application/json
28841         - application/xml
28842       responses:
28843         "200":
28844           description: successful operation
28845           schema:
28846               $ref: "#/getDefinitions/vlans"
28847         "default":
28848           description: Response codes found in [response codes](https://wiki.onap.org/).
28849       parameters:
28850         - name: equipment-name
28851           in: path
28852           required: true
28853           type: string
28854           example: __EQUIPMENT-NAME__
28855         - name: interface-name
28856           in: path
28857           description: Name that identifies the link aggregate interface
28858           required: true
28859           type: string
28860           example: __INTERFACE-NAME__
28861         - name: interface-name
28862           in: path
28863           description: Name given to the interface
28864           required: true
28865           type: string
28866           example: __INTERFACE-NAME__
28867         - name: prov-status
28868           in: query
28869           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28870           required: false
28871           type: string
28872         - name: interface-id
28873           in: query
28874           description: ID of interface
28875           required: false
28876           type: string
28877         - name: interface-role
28878           in: query
28879           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28880           required: false
28881           type: string
28882         - name: interface-id
28883           in: query
28884           description: ID of interface
28885           required: false
28886           type: string
28887         - name: macaddr
28888           in: query
28889           description: MAC address for the interface
28890           required: false
28891           type: string
28892         - name: network-name
28893           in: query
28894           description: Name of the network
28895           required: false
28896           type: string
28897   /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:
28898     put:
28899       tags:
28900         - Network
28901       summary: see node definition for valid relationships
28902       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28903       consumes:
28904         - application/json
28905         - application/xml
28906       produces:
28907         - application/json
28908         - application/xml
28909       responses:
28910         "default":
28911           description: Response codes found in [response codes](https://wiki.onap.org/).
28912       parameters:
28913         - name: equipment-name
28914           in: path
28915           required: true
28916           type: string
28917           example: __EQUIPMENT-NAME__
28918         - name: interface-name
28919           in: path
28920           description: Name that identifies the link aggregate interface
28921           required: true
28922           type: string
28923           example: __INTERFACE-NAME__
28924         - name: interface-name
28925           in: path
28926           description: Name given to the interface
28927           required: true
28928           type: string
28929           example: __INTERFACE-NAME__
28930         - name: pci-id
28931           in: path
28932           description: PCI ID used to identify the sriov-vf
28933           required: true
28934           type: string
28935           example: __PCI-ID__
28936         - name: body
28937           in: body
28938           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28939           required: true
28940           schema:
28941             $ref: "#/definitions/relationship"
28942     delete:
28943       tags:
28944         - Network
28945       summary: delete an existing relationship
28946       description: delete an existing relationship
28947       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28948       consumes:
28949         - application/json
28950         - application/xml
28951       produces:
28952         - application/json
28953         - application/xml
28954       responses:
28955         "default":
28956           description: Response codes found in [response codes](https://wiki.onap.org/).
28957       parameters:
28958         - name: equipment-name
28959           in: path
28960           required: true
28961           type: string
28962           example: __EQUIPMENT-NAME__
28963         - name: interface-name
28964           in: path
28965           description: Name that identifies the link aggregate interface
28966           required: true
28967           type: string
28968           example: __INTERFACE-NAME__
28969         - name: interface-name
28970           in: path
28971           description: Name given to the interface
28972           required: true
28973           type: string
28974           example: __INTERFACE-NAME__
28975         - name: pci-id
28976           in: path
28977           description: PCI ID used to identify the sriov-vf
28978           required: true
28979           type: string
28980           example: __PCI-ID__
28981   /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}:
28982     get:
28983       tags:
28984         - Network
28985       summary: returns sriov-vf
28986       description: returns sriov-vf
28987       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28988       produces:
28989         - application/json
28990         - application/xml
28991       responses:
28992         "200":
28993           description: successful operation
28994           schema:
28995               $ref: "#/getDefinitions/sriov-vf"
28996         "default":
28997           description: Response codes found in [response codes](https://wiki.onap.org/).
28998       parameters:
28999         - name: equipment-name
29000           in: path
29001           required: true
29002           type: string
29003           example: __EQUIPMENT-NAME__
29004         - name: interface-name
29005           in: path
29006           description: Name that identifies the link aggregate interface
29007           required: true
29008           type: string
29009           example: __INTERFACE-NAME__
29010         - name: interface-name
29011           in: path
29012           description: Name given to the interface
29013           required: true
29014           type: string
29015           example: __INTERFACE-NAME__
29016         - name: pci-id
29017           in: path
29018           description: PCI ID used to identify the sriov-vf
29019           required: true
29020           type: string
29021           example: __PCI-ID__
29022         - name: prov-status
29023           in: query
29024           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29025           required: false
29026           type: string
29027         - name: interface-id
29028           in: query
29029           description: ID of interface
29030           required: false
29031           type: string
29032         - name: interface-role
29033           in: query
29034           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29035           required: false
29036           type: string
29037         - name: interface-id
29038           in: query
29039           description: ID of interface
29040           required: false
29041           type: string
29042         - name: macaddr
29043           in: query
29044           description: MAC address for the interface
29045           required: false
29046           type: string
29047         - name: network-name
29048           in: query
29049           description: Name of the network
29050           required: false
29051           type: string
29052         - name: vf-vlan-filter
29053           in: query
29054           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
29055           required: false
29056           type: string
29057         - name: vf-mac-filter
29058           in: query
29059           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
29060           required: false
29061           type: string
29062         - name: vf-vlan-strip
29063           in: query
29064           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
29065           required: false
29066           type: boolean
29067         - name: neutron-network-id
29068           in: query
29069           description: Neutron network id of the interface
29070           required: false
29071           type: string
29072     put:
29073       tags:
29074         - Network
29075       summary: create or update an existing sriov-vf
29076       description: |
29077         Create or update an existing sriov-vf.
29078         #
29079         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
29080       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29081       consumes:
29082         - application/json
29083         - application/xml
29084       produces:
29085         - application/json
29086         - application/xml
29087       responses:
29088         "default":
29089           description: Response codes found in [response codes](https://wiki.onap.org/).
29090       parameters:
29091         - name: equipment-name
29092           in: path
29093           required: true
29094           type: string
29095           example: __EQUIPMENT-NAME__
29096         - name: interface-name
29097           in: path
29098           description: Name that identifies the link aggregate interface
29099           required: true
29100           type: string
29101           example: __INTERFACE-NAME__
29102         - name: interface-name
29103           in: path
29104           description: Name given to the interface
29105           required: true
29106           type: string
29107           example: __INTERFACE-NAME__
29108         - name: pci-id
29109           in: path
29110           description: PCI ID used to identify the sriov-vf
29111           required: true
29112           type: string
29113           example: __PCI-ID__
29114         - name: body
29115           in: body
29116           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
29117           required: true
29118           schema:
29119             $ref: "#/definitions/sriov-vf"
29120     patch:
29121       tags:
29122         - Network
29123       summary: update an existing sriov-vf
29124       description: |
29125         Update an existing sriov-vf
29126         #
29127         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29128         The PUT operation will entirely replace an existing object.
29129         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.
29130         #
29131         Other differences between PUT and PATCH are:
29132         #
29133         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29134         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29135         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29136       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29137       consumes:
29138         - application/json
29139         - application/xml
29140       produces:
29141         - application/json
29142         - application/xml
29143       responses:
29144         "default":
29145           description: Response codes found in [response codes](https://wiki.onap.org/).
29146       parameters:
29147         - name: equipment-name
29148           in: path
29149           required: true
29150           type: string
29151           example: __EQUIPMENT-NAME__
29152         - name: interface-name
29153           in: path
29154           description: Name that identifies the link aggregate interface
29155           required: true
29156           type: string
29157           example: __INTERFACE-NAME__
29158         - name: interface-name
29159           in: path
29160           description: Name given to the interface
29161           required: true
29162           type: string
29163           example: __INTERFACE-NAME__
29164         - name: pci-id
29165           in: path
29166           description: PCI ID used to identify the sriov-vf
29167           required: true
29168           type: string
29169           example: __PCI-ID__
29170         - name: body
29171           in: body
29172           description: sriov-vf object that needs to be created or updated.
29173           required: true
29174           schema:
29175             $ref: "#/patchDefinitions/sriov-vf"
29176     delete:
29177       tags:
29178         - Network
29179       summary: delete an existing sriov-vf
29180       description: delete an existing sriov-vf
29181       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
29182       consumes:
29183         - application/json
29184         - application/xml
29185       produces:
29186         - application/json
29187         - application/xml
29188       responses:
29189         "default":
29190           description: Response codes found in [response codes](https://wiki.onap.org/).
29191       parameters:
29192         - name: equipment-name
29193           in: path
29194           required: true
29195           type: string
29196           example: __EQUIPMENT-NAME__
29197         - name: interface-name
29198           in: path
29199           description: Name that identifies the link aggregate interface
29200           required: true
29201           type: string
29202           example: __INTERFACE-NAME__
29203         - name: interface-name
29204           in: path
29205           description: Name given to the interface
29206           required: true
29207           type: string
29208           example: __INTERFACE-NAME__
29209         - name: pci-id
29210           in: path
29211           description: PCI ID used to identify the sriov-vf
29212           required: true
29213           type: string
29214           example: __PCI-ID__
29215         - name: resource-version
29216           in: query
29217           description: resource-version for concurrency
29218           required: true
29219           type: string
29220   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
29221     get:
29222       tags:
29223         - Network
29224       summary: returns sriov-vfs
29225       description: returns sriov-vfs
29226       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
29227       produces:
29228         - application/json
29229         - application/xml
29230       responses:
29231         "200":
29232           description: successful operation
29233           schema:
29234               $ref: "#/getDefinitions/sriov-vfs"
29235         "default":
29236           description: Response codes found in [response codes](https://wiki.onap.org/).
29237       parameters:
29238         - name: equipment-name
29239           in: path
29240           required: true
29241           type: string
29242           example: __EQUIPMENT-NAME__
29243         - name: interface-name
29244           in: path
29245           description: Name that identifies the link aggregate interface
29246           required: true
29247           type: string
29248           example: __INTERFACE-NAME__
29249         - name: interface-name
29250           in: path
29251           description: Name given to the interface
29252           required: true
29253           type: string
29254           example: __INTERFACE-NAME__
29255         - name: prov-status
29256           in: query
29257           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29258           required: false
29259           type: string
29260         - name: interface-id
29261           in: query
29262           description: ID of interface
29263           required: false
29264           type: string
29265         - name: interface-role
29266           in: query
29267           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29268           required: false
29269           type: string
29270         - name: interface-id
29271           in: query
29272           description: ID of interface
29273           required: false
29274           type: string
29275         - name: macaddr
29276           in: query
29277           description: MAC address for the interface
29278           required: false
29279           type: string
29280         - name: network-name
29281           in: query
29282           description: Name of the network
29283           required: false
29284           type: string
29285   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
29286     put:
29287       tags:
29288         - Network
29289       summary: see node definition for valid relationships
29290       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
29291       consumes:
29292         - application/json
29293         - application/xml
29294       produces:
29295         - application/json
29296         - application/xml
29297       responses:
29298         "default":
29299           description: Response codes found in [response codes](https://wiki.onap.org/).
29300       parameters:
29301         - name: equipment-name
29302           in: path
29303           required: true
29304           type: string
29305           example: __EQUIPMENT-NAME__
29306         - name: interface-name
29307           in: path
29308           description: Name that identifies the link aggregate interface
29309           required: true
29310           type: string
29311           example: __INTERFACE-NAME__
29312         - name: interface-name
29313           in: path
29314           description: Name given to the interface
29315           required: true
29316           type: string
29317           example: __INTERFACE-NAME__
29318         - name: body
29319           in: body
29320           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
29321           required: true
29322           schema:
29323             $ref: "#/definitions/relationship"
29324     delete:
29325       tags:
29326         - Network
29327       summary: delete an existing relationship
29328       description: delete an existing relationship
29329       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
29330       consumes:
29331         - application/json
29332         - application/xml
29333       produces:
29334         - application/json
29335         - application/xml
29336       responses:
29337         "default":
29338           description: Response codes found in [response codes](https://wiki.onap.org/).
29339       parameters:
29340         - name: equipment-name
29341           in: path
29342           required: true
29343           type: string
29344           example: __EQUIPMENT-NAME__
29345         - name: interface-name
29346           in: path
29347           description: Name that identifies the link aggregate interface
29348           required: true
29349           type: string
29350           example: __INTERFACE-NAME__
29351         - name: interface-name
29352           in: path
29353           description: Name given to the interface
29354           required: true
29355           type: string
29356           example: __INTERFACE-NAME__
29357   /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:
29358     put:
29359       tags:
29360         - Network
29361       summary: see node definition for valid relationships
29362       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29363       consumes:
29364         - application/json
29365         - application/xml
29366       produces:
29367         - application/json
29368         - application/xml
29369       responses:
29370         "default":
29371           description: Response codes found in [response codes](https://wiki.onap.org/).
29372       parameters:
29373         - name: equipment-name
29374           in: path
29375           required: true
29376           type: string
29377           example: __EQUIPMENT-NAME__
29378         - name: interface-name
29379           in: path
29380           description: Name that identifies the link aggregate interface
29381           required: true
29382           type: string
29383           example: __INTERFACE-NAME__
29384         - name: interface-name
29385           in: path
29386           description: Name given to the interface
29387           required: true
29388           type: string
29389           example: __INTERFACE-NAME__
29390         - name: l3-interface-ipv4-address
29391           in: path
29392           description: IP address
29393           required: true
29394           type: string
29395           example: __L3-INTERFACE-IPV4-ADDRESS__
29396         - name: body
29397           in: body
29398           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
29399           required: true
29400           schema:
29401             $ref: "#/definitions/relationship"
29402     delete:
29403       tags:
29404         - Network
29405       summary: delete an existing relationship
29406       description: delete an existing relationship
29407       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29408       consumes:
29409         - application/json
29410         - application/xml
29411       produces:
29412         - application/json
29413         - application/xml
29414       responses:
29415         "default":
29416           description: Response codes found in [response codes](https://wiki.onap.org/).
29417       parameters:
29418         - name: equipment-name
29419           in: path
29420           required: true
29421           type: string
29422           example: __EQUIPMENT-NAME__
29423         - name: interface-name
29424           in: path
29425           description: Name that identifies the link aggregate interface
29426           required: true
29427           type: string
29428           example: __INTERFACE-NAME__
29429         - name: interface-name
29430           in: path
29431           description: Name given to the interface
29432           required: true
29433           type: string
29434           example: __INTERFACE-NAME__
29435         - name: l3-interface-ipv4-address
29436           in: path
29437           description: IP address
29438           required: true
29439           type: string
29440           example: __L3-INTERFACE-IPV4-ADDRESS__
29441   /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}:
29442     get:
29443       tags:
29444         - Network
29445       summary: returns l3-interface-ipv4-address-list
29446       description: returns l3-interface-ipv4-address-list
29447       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29448       produces:
29449         - application/json
29450         - application/xml
29451       responses:
29452         "200":
29453           description: successful operation
29454           schema:
29455               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29456         "default":
29457           description: Response codes found in [response codes](https://wiki.onap.org/).
29458       parameters:
29459         - name: equipment-name
29460           in: path
29461           required: true
29462           type: string
29463           example: __EQUIPMENT-NAME__
29464         - name: interface-name
29465           in: path
29466           description: Name that identifies the link aggregate interface
29467           required: true
29468           type: string
29469           example: __INTERFACE-NAME__
29470         - name: interface-name
29471           in: path
29472           description: Name given to the interface
29473           required: true
29474           type: string
29475           example: __INTERFACE-NAME__
29476         - name: l3-interface-ipv4-address
29477           in: path
29478           description: IP address
29479           required: true
29480           type: string
29481           example: __L3-INTERFACE-IPV4-ADDRESS__
29482         - name: prov-status
29483           in: query
29484           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29485           required: false
29486           type: string
29487         - name: interface-id
29488           in: query
29489           description: ID of interface
29490           required: false
29491           type: string
29492         - name: interface-role
29493           in: query
29494           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29495           required: false
29496           type: string
29497         - name: interface-id
29498           in: query
29499           description: ID of interface
29500           required: false
29501           type: string
29502         - name: macaddr
29503           in: query
29504           description: MAC address for the interface
29505           required: false
29506           type: string
29507         - name: network-name
29508           in: query
29509           description: Name of the network
29510           required: false
29511           type: string
29512         - name: vlan-id-inner
29513           in: query
29514           description: Inner VLAN tag
29515           required: false
29516           type: integer
29517           format: int64
29518         - name: neutron-network-id
29519           in: query
29520           description: Neutron network id of the interface that address belongs to
29521           required: false
29522           type: string
29523         - name: neutron-subnet-id
29524           in: query
29525           description: Neutron id of subnet that address belongs to
29526           required: false
29527           type: string
29528     put:
29529       tags:
29530         - Network
29531       summary: create or update an existing l3-interface-ipv4-address-list
29532       description: |
29533         Create or update an existing l3-interface-ipv4-address-list.
29534         #
29535         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
29536       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29537       consumes:
29538         - application/json
29539         - application/xml
29540       produces:
29541         - application/json
29542         - application/xml
29543       responses:
29544         "default":
29545           description: Response codes found in [response codes](https://wiki.onap.org/).
29546       parameters:
29547         - name: equipment-name
29548           in: path
29549           required: true
29550           type: string
29551           example: __EQUIPMENT-NAME__
29552         - name: interface-name
29553           in: path
29554           description: Name that identifies the link aggregate interface
29555           required: true
29556           type: string
29557           example: __INTERFACE-NAME__
29558         - name: interface-name
29559           in: path
29560           description: Name given to the interface
29561           required: true
29562           type: string
29563           example: __INTERFACE-NAME__
29564         - name: l3-interface-ipv4-address
29565           in: path
29566           description: IP address
29567           required: true
29568           type: string
29569           example: __L3-INTERFACE-IPV4-ADDRESS__
29570         - name: body
29571           in: body
29572           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
29573           required: true
29574           schema:
29575             $ref: "#/definitions/l3-interface-ipv4-address-list"
29576     patch:
29577       tags:
29578         - Network
29579       summary: update an existing l3-interface-ipv4-address-list
29580       description: |
29581         Update an existing l3-interface-ipv4-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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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: equipment-name
29604           in: path
29605           required: true
29606           type: string
29607           example: __EQUIPMENT-NAME__
29608         - name: interface-name
29609           in: path
29610           description: Name that identifies the link aggregate interface
29611           required: true
29612           type: string
29613           example: __INTERFACE-NAME__
29614         - name: interface-name
29615           in: path
29616           description: Name given to the interface
29617           required: true
29618           type: string
29619           example: __INTERFACE-NAME__
29620         - name: l3-interface-ipv4-address
29621           in: path
29622           description: IP address
29623           required: true
29624           type: string
29625           example: __L3-INTERFACE-IPV4-ADDRESS__
29626         - name: body
29627           in: body
29628           description: l3-interface-ipv4-address-list object that needs to be created or updated.
29629           required: true
29630           schema:
29631             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29632     delete:
29633       tags:
29634         - Network
29635       summary: delete an existing l3-interface-ipv4-address-list
29636       description: delete an existing l3-interface-ipv4-address-list
29637       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
29638       consumes:
29639         - application/json
29640         - application/xml
29641       produces:
29642         - application/json
29643         - application/xml
29644       responses:
29645         "default":
29646           description: Response codes found in [response codes](https://wiki.onap.org/).
29647       parameters:
29648         - name: equipment-name
29649           in: path
29650           required: true
29651           type: string
29652           example: __EQUIPMENT-NAME__
29653         - name: interface-name
29654           in: path
29655           description: Name that identifies the link aggregate interface
29656           required: true
29657           type: string
29658           example: __INTERFACE-NAME__
29659         - name: interface-name
29660           in: path
29661           description: Name given to the interface
29662           required: true
29663           type: string
29664           example: __INTERFACE-NAME__
29665         - name: l3-interface-ipv4-address
29666           in: path
29667           description: IP address
29668           required: true
29669           type: string
29670           example: __L3-INTERFACE-IPV4-ADDRESS__
29671         - name: resource-version
29672           in: query
29673           description: resource-version for concurrency
29674           required: true
29675           type: string
29676   /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:
29677     put:
29678       tags:
29679         - Network
29680       summary: see node definition for valid relationships
29681       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
29682       consumes:
29683         - application/json
29684         - application/xml
29685       produces:
29686         - application/json
29687         - application/xml
29688       responses:
29689         "default":
29690           description: Response codes found in [response codes](https://wiki.onap.org/).
29691       parameters:
29692         - name: equipment-name
29693           in: path
29694           required: true
29695           type: string
29696           example: __EQUIPMENT-NAME__
29697         - name: interface-name
29698           in: path
29699           description: Name that identifies the link aggregate interface
29700           required: true
29701           type: string
29702           example: __INTERFACE-NAME__
29703         - name: interface-name
29704           in: path
29705           description: Name given to the interface
29706           required: true
29707           type: string
29708           example: __INTERFACE-NAME__
29709         - name: l3-interface-ipv6-address
29710           in: path
29711           description: IP address
29712           required: true
29713           type: string
29714           example: __L3-INTERFACE-IPV6-ADDRESS__
29715         - name: body
29716           in: body
29717           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29718           required: true
29719           schema:
29720             $ref: "#/definitions/relationship"
29721     delete:
29722       tags:
29723         - Network
29724       summary: delete an existing relationship
29725       description: delete an existing relationship
29726       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
29727       consumes:
29728         - application/json
29729         - application/xml
29730       produces:
29731         - application/json
29732         - application/xml
29733       responses:
29734         "default":
29735           description: Response codes found in [response codes](https://wiki.onap.org/).
29736       parameters:
29737         - name: equipment-name
29738           in: path
29739           required: true
29740           type: string
29741           example: __EQUIPMENT-NAME__
29742         - name: interface-name
29743           in: path
29744           description: Name that identifies the link aggregate interface
29745           required: true
29746           type: string
29747           example: __INTERFACE-NAME__
29748         - name: interface-name
29749           in: path
29750           description: Name given to the interface
29751           required: true
29752           type: string
29753           example: __INTERFACE-NAME__
29754         - name: l3-interface-ipv6-address
29755           in: path
29756           description: IP address
29757           required: true
29758           type: string
29759           example: __L3-INTERFACE-IPV6-ADDRESS__
29760   /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}:
29761     get:
29762       tags:
29763         - Network
29764       summary: returns l3-interface-ipv6-address-list
29765       description: returns l3-interface-ipv6-address-list
29766       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29767       produces:
29768         - application/json
29769         - application/xml
29770       responses:
29771         "200":
29772           description: successful operation
29773           schema:
29774               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29775         "default":
29776           description: Response codes found in [response codes](https://wiki.onap.org/).
29777       parameters:
29778         - name: equipment-name
29779           in: path
29780           required: true
29781           type: string
29782           example: __EQUIPMENT-NAME__
29783         - name: interface-name
29784           in: path
29785           description: Name that identifies the link aggregate interface
29786           required: true
29787           type: string
29788           example: __INTERFACE-NAME__
29789         - name: interface-name
29790           in: path
29791           description: Name given to the interface
29792           required: true
29793           type: string
29794           example: __INTERFACE-NAME__
29795         - name: l3-interface-ipv6-address
29796           in: path
29797           description: IP address
29798           required: true
29799           type: string
29800           example: __L3-INTERFACE-IPV6-ADDRESS__
29801         - name: prov-status
29802           in: query
29803           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29804           required: false
29805           type: string
29806         - name: interface-id
29807           in: query
29808           description: ID of interface
29809           required: false
29810           type: string
29811         - name: interface-role
29812           in: query
29813           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29814           required: false
29815           type: string
29816         - name: interface-id
29817           in: query
29818           description: ID of interface
29819           required: false
29820           type: string
29821         - name: macaddr
29822           in: query
29823           description: MAC address for the interface
29824           required: false
29825           type: string
29826         - name: network-name
29827           in: query
29828           description: Name of the network
29829           required: false
29830           type: string
29831         - name: vlan-id-inner
29832           in: query
29833           description: Inner VLAN tag
29834           required: false
29835           type: integer
29836           format: int64
29837         - name: neutron-network-id
29838           in: query
29839           description: Neutron network id of the interface that address belongs to
29840           required: false
29841           type: string
29842         - name: neutron-subnet-id
29843           in: query
29844           description: Neutron id of subnet that address belongs to
29845           required: false
29846           type: string
29847     put:
29848       tags:
29849         - Network
29850       summary: create or update an existing l3-interface-ipv6-address-list
29851       description: |
29852         Create or update an existing l3-interface-ipv6-address-list.
29853         #
29854         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
29855       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29856       consumes:
29857         - application/json
29858         - application/xml
29859       produces:
29860         - application/json
29861         - application/xml
29862       responses:
29863         "default":
29864           description: Response codes found in [response codes](https://wiki.onap.org/).
29865       parameters:
29866         - name: equipment-name
29867           in: path
29868           required: true
29869           type: string
29870           example: __EQUIPMENT-NAME__
29871         - name: interface-name
29872           in: path
29873           description: Name that identifies the link aggregate interface
29874           required: true
29875           type: string
29876           example: __INTERFACE-NAME__
29877         - name: interface-name
29878           in: path
29879           description: Name given to the interface
29880           required: true
29881           type: string
29882           example: __INTERFACE-NAME__
29883         - name: l3-interface-ipv6-address
29884           in: path
29885           description: IP address
29886           required: true
29887           type: string
29888           example: __L3-INTERFACE-IPV6-ADDRESS__
29889         - name: body
29890           in: body
29891           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29892           required: true
29893           schema:
29894             $ref: "#/definitions/l3-interface-ipv6-address-list"
29895     patch:
29896       tags:
29897         - Network
29898       summary: update an existing l3-interface-ipv6-address-list
29899       description: |
29900         Update an existing l3-interface-ipv6-address-list
29901         #
29902         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29903         The PUT operation will entirely replace an existing object.
29904         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.
29905         #
29906         Other differences between PUT and PATCH are:
29907         #
29908         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29909         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29910         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29911       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29912       consumes:
29913         - application/json
29914         - application/xml
29915       produces:
29916         - application/json
29917         - application/xml
29918       responses:
29919         "default":
29920           description: Response codes found in [response codes](https://wiki.onap.org/).
29921       parameters:
29922         - name: equipment-name
29923           in: path
29924           required: true
29925           type: string
29926           example: __EQUIPMENT-NAME__
29927         - name: interface-name
29928           in: path
29929           description: Name that identifies the link aggregate interface
29930           required: true
29931           type: string
29932           example: __INTERFACE-NAME__
29933         - name: interface-name
29934           in: path
29935           description: Name given to the interface
29936           required: true
29937           type: string
29938           example: __INTERFACE-NAME__
29939         - name: l3-interface-ipv6-address
29940           in: path
29941           description: IP address
29942           required: true
29943           type: string
29944           example: __L3-INTERFACE-IPV6-ADDRESS__
29945         - name: body
29946           in: body
29947           description: l3-interface-ipv6-address-list object that needs to be created or updated.
29948           required: true
29949           schema:
29950             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29951     delete:
29952       tags:
29953         - Network
29954       summary: delete an existing l3-interface-ipv6-address-list
29955       description: delete an existing l3-interface-ipv6-address-list
29956       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29957       consumes:
29958         - application/json
29959         - application/xml
29960       produces:
29961         - application/json
29962         - application/xml
29963       responses:
29964         "default":
29965           description: Response codes found in [response codes](https://wiki.onap.org/).
29966       parameters:
29967         - name: equipment-name
29968           in: path
29969           required: true
29970           type: string
29971           example: __EQUIPMENT-NAME__
29972         - name: interface-name
29973           in: path
29974           description: Name that identifies the link aggregate interface
29975           required: true
29976           type: string
29977           example: __INTERFACE-NAME__
29978         - name: interface-name
29979           in: path
29980           description: Name given to the interface
29981           required: true
29982           type: string
29983           example: __INTERFACE-NAME__
29984         - name: l3-interface-ipv6-address
29985           in: path
29986           description: IP address
29987           required: true
29988           type: string
29989           example: __L3-INTERFACE-IPV6-ADDRESS__
29990         - name: resource-version
29991           in: query
29992           description: resource-version for concurrency
29993           required: true
29994           type: string
29995   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
29996     get:
29997       tags:
29998         - Network
29999       summary: returns l-interface
30000       description: returns l-interface
30001       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30002       produces:
30003         - application/json
30004         - application/xml
30005       responses:
30006         "200":
30007           description: successful operation
30008           schema:
30009               $ref: "#/getDefinitions/l-interface"
30010         "default":
30011           description: Response codes found in [response codes](https://wiki.onap.org/).
30012       parameters:
30013         - name: equipment-name
30014           in: path
30015           required: true
30016           type: string
30017           example: __EQUIPMENT-NAME__
30018         - name: interface-name
30019           in: path
30020           description: Name that identifies the link aggregate interface
30021           required: true
30022           type: string
30023           example: __INTERFACE-NAME__
30024         - name: interface-name
30025           in: path
30026           description: Name given to the interface
30027           required: true
30028           type: string
30029           example: __INTERFACE-NAME__
30030         - name: prov-status
30031           in: query
30032           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30033           required: false
30034           type: string
30035         - name: interface-id
30036           in: query
30037           description: ID of interface
30038           required: false
30039           type: string
30040         - name: interface-role
30041           in: query
30042           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30043           required: false
30044           type: string
30045         - name: interface-id
30046           in: query
30047           description: ID of interface
30048           required: false
30049           type: string
30050         - name: macaddr
30051           in: query
30052           description: MAC address for the interface
30053           required: false
30054           type: string
30055         - name: network-name
30056           in: query
30057           description: Name of the network
30058           required: false
30059           type: string
30060     put:
30061       tags:
30062         - Network
30063       summary: create or update an existing l-interface
30064       description: |
30065         Create or update an existing l-interface.
30066         #
30067         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
30068       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30069       consumes:
30070         - application/json
30071         - application/xml
30072       produces:
30073         - application/json
30074         - application/xml
30075       responses:
30076         "default":
30077           description: Response codes found in [response codes](https://wiki.onap.org/).
30078       parameters:
30079         - name: equipment-name
30080           in: path
30081           required: true
30082           type: string
30083           example: __EQUIPMENT-NAME__
30084         - name: interface-name
30085           in: path
30086           description: Name that identifies the link aggregate interface
30087           required: true
30088           type: string
30089           example: __INTERFACE-NAME__
30090         - name: interface-name
30091           in: path
30092           description: Name given to the interface
30093           required: true
30094           type: string
30095           example: __INTERFACE-NAME__
30096         - name: body
30097           in: body
30098           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
30099           required: true
30100           schema:
30101             $ref: "#/definitions/l-interface"
30102     patch:
30103       tags:
30104         - Network
30105       summary: update an existing l-interface
30106       description: |
30107         Update an existing l-interface
30108         #
30109         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30110         The PUT operation will entirely replace an existing object.
30111         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.
30112         #
30113         Other differences between PUT and PATCH are:
30114         #
30115         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30116         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30117         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30118       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30119       consumes:
30120         - application/json
30121         - application/xml
30122       produces:
30123         - application/json
30124         - application/xml
30125       responses:
30126         "default":
30127           description: Response codes found in [response codes](https://wiki.onap.org/).
30128       parameters:
30129         - name: equipment-name
30130           in: path
30131           required: true
30132           type: string
30133           example: __EQUIPMENT-NAME__
30134         - name: interface-name
30135           in: path
30136           description: Name that identifies the link aggregate interface
30137           required: true
30138           type: string
30139           example: __INTERFACE-NAME__
30140         - name: interface-name
30141           in: path
30142           description: Name given to the interface
30143           required: true
30144           type: string
30145           example: __INTERFACE-NAME__
30146         - name: body
30147           in: body
30148           description: l-interface object that needs to be created or updated.
30149           required: true
30150           schema:
30151             $ref: "#/patchDefinitions/l-interface"
30152     delete:
30153       tags:
30154         - Network
30155       summary: delete an existing l-interface
30156       description: delete an existing l-interface
30157       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
30158       consumes:
30159         - application/json
30160         - application/xml
30161       produces:
30162         - application/json
30163         - application/xml
30164       responses:
30165         "default":
30166           description: Response codes found in [response codes](https://wiki.onap.org/).
30167       parameters:
30168         - name: equipment-name
30169           in: path
30170           required: true
30171           type: string
30172           example: __EQUIPMENT-NAME__
30173         - name: interface-name
30174           in: path
30175           description: Name that identifies the link aggregate interface
30176           required: true
30177           type: string
30178           example: __INTERFACE-NAME__
30179         - name: interface-name
30180           in: path
30181           description: Name given to the interface
30182           required: true
30183           type: string
30184           example: __INTERFACE-NAME__
30185         - name: resource-version
30186           in: query
30187           description: resource-version for concurrency
30188           required: true
30189           type: string
30190   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
30191     get:
30192       tags:
30193         - Network
30194       summary: returns l-interfaces
30195       description: returns l-interfaces
30196       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
30197       produces:
30198         - application/json
30199         - application/xml
30200       responses:
30201         "200":
30202           description: successful operation
30203           schema:
30204               $ref: "#/getDefinitions/l-interfaces"
30205         "default":
30206           description: Response codes found in [response codes](https://wiki.onap.org/).
30207       parameters:
30208         - name: equipment-name
30209           in: path
30210           required: true
30211           type: string
30212           example: __EQUIPMENT-NAME__
30213         - name: interface-name
30214           in: path
30215           description: Name that identifies the link aggregate interface
30216           required: true
30217           type: string
30218           example: __INTERFACE-NAME__
30219         - name: prov-status
30220           in: query
30221           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30222           required: false
30223           type: string
30224         - name: interface-id
30225           in: query
30226           description: ID of interface
30227           required: false
30228           type: string
30229         - name: interface-role
30230           in: query
30231           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30232           required: false
30233           type: string
30234   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
30235     get:
30236       tags:
30237         - Network
30238       summary: returns lag-interface
30239       description: returns lag-interface
30240       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
30241       produces:
30242         - application/json
30243         - application/xml
30244       responses:
30245         "200":
30246           description: successful operation
30247           schema:
30248               $ref: "#/getDefinitions/lag-interface"
30249         "default":
30250           description: Response codes found in [response codes](https://wiki.onap.org/).
30251       parameters:
30252         - name: equipment-name
30253           in: path
30254           required: true
30255           type: string
30256           example: __EQUIPMENT-NAME__
30257         - name: interface-name
30258           in: path
30259           description: Name that identifies the link aggregate interface
30260           required: true
30261           type: string
30262           example: __INTERFACE-NAME__
30263         - name: prov-status
30264           in: query
30265           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30266           required: false
30267           type: string
30268         - name: interface-id
30269           in: query
30270           description: ID of interface
30271           required: false
30272           type: string
30273         - name: interface-role
30274           in: query
30275           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
30276           required: false
30277           type: string
30278     put:
30279       tags:
30280         - Network
30281       summary: create or update an existing lag-interface
30282       description: |
30283         Create or update an existing lag-interface.
30284         #
30285         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
30286       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
30287       consumes:
30288         - application/json
30289         - application/xml
30290       produces:
30291         - application/json
30292         - application/xml
30293       responses:
30294         "default":
30295           description: Response codes found in [response codes](https://wiki.onap.org/).
30296       parameters:
30297         - name: equipment-name
30298           in: path
30299           required: true
30300           type: string
30301           example: __EQUIPMENT-NAME__
30302         - name: interface-name
30303           in: path
30304           description: Name that identifies the link aggregate interface
30305           required: true
30306           type: string
30307           example: __INTERFACE-NAME__
30308         - name: body
30309           in: body
30310           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
30311           required: true
30312           schema:
30313             $ref: "#/definitions/lag-interface"
30314     patch:
30315       tags:
30316         - Network
30317       summary: update an existing lag-interface
30318       description: |
30319         Update an existing lag-interface
30320         #
30321         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30322         The PUT operation will entirely replace an existing object.
30323         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.
30324         #
30325         Other differences between PUT and PATCH are:
30326         #
30327         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30328         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30329         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30330       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
30331       consumes:
30332         - application/json
30333         - application/xml
30334       produces:
30335         - application/json
30336         - application/xml
30337       responses:
30338         "default":
30339           description: Response codes found in [response codes](https://wiki.onap.org/).
30340       parameters:
30341         - name: equipment-name
30342           in: path
30343           required: true
30344           type: string
30345           example: __EQUIPMENT-NAME__
30346         - name: interface-name
30347           in: path
30348           description: Name that identifies the link aggregate interface
30349           required: true
30350           type: string
30351           example: __INTERFACE-NAME__
30352         - name: body
30353           in: body
30354           description: lag-interface object that needs to be created or updated.
30355           required: true
30356           schema:
30357             $ref: "#/patchDefinitions/lag-interface"
30358     delete:
30359       tags:
30360         - Network
30361       summary: delete an existing lag-interface
30362       description: delete an existing lag-interface
30363       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
30364       consumes:
30365         - application/json
30366         - application/xml
30367       produces:
30368         - application/json
30369         - application/xml
30370       responses:
30371         "default":
30372           description: Response codes found in [response codes](https://wiki.onap.org/).
30373       parameters:
30374         - name: equipment-name
30375           in: path
30376           required: true
30377           type: string
30378           example: __EQUIPMENT-NAME__
30379         - name: interface-name
30380           in: path
30381           description: Name that identifies the link aggregate interface
30382           required: true
30383           type: string
30384           example: __INTERFACE-NAME__
30385         - name: resource-version
30386           in: query
30387           description: resource-version for concurrency
30388           required: true
30389           type: string
30390   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
30391     get:
30392       tags:
30393         - Network
30394       summary: returns lag-interfaces
30395       description: returns lag-interfaces
30396       operationId: getNetworkVplsPesVplsPeLagInterfaces
30397       produces:
30398         - application/json
30399         - application/xml
30400       responses:
30401         "200":
30402           description: successful operation
30403           schema:
30404               $ref: "#/getDefinitions/lag-interfaces"
30405         "default":
30406           description: Response codes found in [response codes](https://wiki.onap.org/).
30407       parameters:
30408         - name: equipment-name
30409           in: path
30410           required: true
30411           type: string
30412           example: __EQUIPMENT-NAME__
30413         - name: prov-status
30414           in: query
30415           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30416           required: false
30417           type: string
30418   /network/vpls-pes/vpls-pe/{equipment-name}:
30419     get:
30420       tags:
30421         - Network
30422       summary: returns vpls-pe
30423       description: returns vpls-pe
30424       operationId: getNetworkVplsPesVplsPe
30425       produces:
30426         - application/json
30427         - application/xml
30428       responses:
30429         "200":
30430           description: successful operation
30431           schema:
30432               $ref: "#/getDefinitions/vpls-pe"
30433         "default":
30434           description: Response codes found in [response codes](https://wiki.onap.org/).
30435       parameters:
30436         - name: equipment-name
30437           in: path
30438           required: true
30439           type: string
30440           example: __EQUIPMENT-NAME__
30441         - name: prov-status
30442           in: query
30443           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
30444           required: false
30445           type: string
30446     put:
30447       tags:
30448         - Network
30449       summary: create or update an existing vpls-pe
30450       description: |
30451         Create or update an existing vpls-pe.
30452         #
30453         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
30454       operationId: createOrUpdateNetworkVplsPesVplsPe
30455       consumes:
30456         - application/json
30457         - application/xml
30458       produces:
30459         - application/json
30460         - application/xml
30461       responses:
30462         "default":
30463           description: Response codes found in [response codes](https://wiki.onap.org/).
30464       parameters:
30465         - name: equipment-name
30466           in: path
30467           required: true
30468           type: string
30469           example: __EQUIPMENT-NAME__
30470         - name: body
30471           in: body
30472           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
30473           required: true
30474           schema:
30475             $ref: "#/definitions/vpls-pe"
30476     patch:
30477       tags:
30478         - Network
30479       summary: update an existing vpls-pe
30480       description: |
30481         Update an existing vpls-pe
30482         #
30483         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30484         The PUT operation will entirely replace an existing object.
30485         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.
30486         #
30487         Other differences between PUT and PATCH are:
30488         #
30489         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30490         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30491         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30492       operationId: UpdateNetworkVplsPesVplsPe
30493       consumes:
30494         - application/json
30495         - application/xml
30496       produces:
30497         - application/json
30498         - application/xml
30499       responses:
30500         "default":
30501           description: Response codes found in [response codes](https://wiki.onap.org/).
30502       parameters:
30503         - name: equipment-name
30504           in: path
30505           required: true
30506           type: string
30507           example: __EQUIPMENT-NAME__
30508         - name: body
30509           in: body
30510           description: vpls-pe object that needs to be created or updated.
30511           required: true
30512           schema:
30513             $ref: "#/patchDefinitions/vpls-pe"
30514     delete:
30515       tags:
30516         - Network
30517       summary: delete an existing vpls-pe
30518       description: delete an existing vpls-pe
30519       operationId: deleteNetworkVplsPesVplsPe
30520       consumes:
30521         - application/json
30522         - application/xml
30523       produces:
30524         - application/json
30525         - application/xml
30526       responses:
30527         "default":
30528           description: Response codes found in [response codes](https://wiki.onap.org/).
30529       parameters:
30530         - name: equipment-name
30531           in: path
30532           required: true
30533           type: string
30534           example: __EQUIPMENT-NAME__
30535         - name: resource-version
30536           in: query
30537           description: resource-version for concurrency
30538           required: true
30539           type: string
30540   /network/vpls-pes:
30541     get:
30542       tags:
30543         - Network
30544       summary: returns vpls-pes
30545       description: returns vpls-pes
30546       operationId: getNetworkVplsPes
30547       produces:
30548         - application/json
30549         - application/xml
30550       responses:
30551         "200":
30552           description: successful operation
30553           schema:
30554               $ref: "#/getDefinitions/vpls-pes"
30555         "default":
30556           description: Response codes found in [response codes](https://wiki.onap.org/).
30557   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
30558     put:
30559       tags:
30560         - Network
30561       summary: see node definition for valid relationships
30562       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
30563       consumes:
30564         - application/json
30565         - application/xml
30566       produces:
30567         - application/json
30568         - application/xml
30569       responses:
30570         "default":
30571           description: Response codes found in [response codes](https://wiki.onap.org/).
30572       parameters:
30573         - name: multicast-configuration-id
30574           in: path
30575           description: Unique id of multicast configuration.
30576           required: true
30577           type: string
30578           example: __MULTICAST-CONFIGURATION-ID__
30579         - name: body
30580           in: body
30581           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
30582           required: true
30583           schema:
30584             $ref: "#/definitions/relationship"
30585     delete:
30586       tags:
30587         - Network
30588       summary: delete an existing relationship
30589       description: delete an existing relationship
30590       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
30591       consumes:
30592         - application/json
30593         - application/xml
30594       produces:
30595         - application/json
30596         - application/xml
30597       responses:
30598         "default":
30599           description: Response codes found in [response codes](https://wiki.onap.org/).
30600       parameters:
30601         - name: multicast-configuration-id
30602           in: path
30603           description: Unique id of multicast configuration.
30604           required: true
30605           type: string
30606           example: __MULTICAST-CONFIGURATION-ID__
30607   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
30608     get:
30609       tags:
30610         - Network
30611       summary: returns multicast-configuration
30612       description: returns multicast-configuration
30613       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
30614       produces:
30615         - application/json
30616         - application/xml
30617       responses:
30618         "200":
30619           description: successful operation
30620           schema:
30621               $ref: "#/getDefinitions/multicast-configuration"
30622         "default":
30623           description: Response codes found in [response codes](https://wiki.onap.org/).
30624       parameters:
30625         - name: multicast-configuration-id
30626           in: path
30627           description: Unique id of multicast configuration.
30628           required: true
30629           type: string
30630           example: __MULTICAST-CONFIGURATION-ID__
30631     put:
30632       tags:
30633         - Network
30634       summary: create or update an existing multicast-configuration
30635       description: |
30636         Create or update an existing multicast-configuration.
30637         #
30638         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
30639       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
30640       consumes:
30641         - application/json
30642         - application/xml
30643       produces:
30644         - application/json
30645         - application/xml
30646       responses:
30647         "default":
30648           description: Response codes found in [response codes](https://wiki.onap.org/).
30649       parameters:
30650         - name: multicast-configuration-id
30651           in: path
30652           description: Unique id of multicast configuration.
30653           required: true
30654           type: string
30655           example: __MULTICAST-CONFIGURATION-ID__
30656         - name: body
30657           in: body
30658           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
30659           required: true
30660           schema:
30661             $ref: "#/definitions/multicast-configuration"
30662     patch:
30663       tags:
30664         - Network
30665       summary: update an existing multicast-configuration
30666       description: |
30667         Update an existing multicast-configuration
30668         #
30669         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30670         The PUT operation will entirely replace an existing object.
30671         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.
30672         #
30673         Other differences between PUT and PATCH are:
30674         #
30675         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30676         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30677         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30678       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
30679       consumes:
30680         - application/json
30681         - application/xml
30682       produces:
30683         - application/json
30684         - application/xml
30685       responses:
30686         "default":
30687           description: Response codes found in [response codes](https://wiki.onap.org/).
30688       parameters:
30689         - name: multicast-configuration-id
30690           in: path
30691           description: Unique id of multicast configuration.
30692           required: true
30693           type: string
30694           example: __MULTICAST-CONFIGURATION-ID__
30695         - name: body
30696           in: body
30697           description: multicast-configuration object that needs to be created or updated.
30698           required: true
30699           schema:
30700             $ref: "#/patchDefinitions/multicast-configuration"
30701     delete:
30702       tags:
30703         - Network
30704       summary: delete an existing multicast-configuration
30705       description: delete an existing multicast-configuration
30706       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
30707       consumes:
30708         - application/json
30709         - application/xml
30710       produces:
30711         - application/json
30712         - application/xml
30713       responses:
30714         "default":
30715           description: Response codes found in [response codes](https://wiki.onap.org/).
30716       parameters:
30717         - name: multicast-configuration-id
30718           in: path
30719           description: Unique id of multicast configuration.
30720           required: true
30721           type: string
30722           example: __MULTICAST-CONFIGURATION-ID__
30723         - name: resource-version
30724           in: query
30725           description: resource-version for concurrency
30726           required: true
30727           type: string
30728   /network/multicast-configurations:
30729     get:
30730       tags:
30731         - Network
30732       summary: returns multicast-configurations
30733       description: returns multicast-configurations
30734       operationId: getNetworkMulticastConfigurations
30735       produces:
30736         - application/json
30737         - application/xml
30738       responses:
30739         "200":
30740           description: successful operation
30741           schema:
30742               $ref: "#/getDefinitions/multicast-configurations"
30743         "default":
30744           description: Response codes found in [response codes](https://wiki.onap.org/).
30745   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
30746     put:
30747       tags:
30748         - Network
30749       summary: see node definition for valid relationships
30750       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
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: vnf-id
30762           in: path
30763           description: Unique id of VNF.  This is unique across the graph.
30764           required: true
30765           type: string
30766           example: __VNF-ID__
30767         - name: interface-id
30768           in: path
30769           description: Unique ID of the interface
30770           required: true
30771           type: string
30772           example: __INTERFACE-ID__
30773         - name: cvlan-tag
30774           in: path
30775           description: See mis-na-virtualization-platform.yang
30776           required: true
30777           type: integer
30778           format: int64
30779           example: __CVLAN-TAG__
30780         - name: body
30781           in: body
30782           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
30783           required: true
30784           schema:
30785             $ref: "#/definitions/relationship"
30786     delete:
30787       tags:
30788         - Network
30789       summary: delete an existing relationship
30790       description: delete an existing relationship
30791       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
30792       consumes:
30793         - application/json
30794         - application/xml
30795       produces:
30796         - application/json
30797         - application/xml
30798       responses:
30799         "default":
30800           description: Response codes found in [response codes](https://wiki.onap.org/).
30801       parameters:
30802         - name: vnf-id
30803           in: path
30804           description: Unique id of VNF.  This is unique across the graph.
30805           required: true
30806           type: string
30807           example: __VNF-ID__
30808         - name: interface-id
30809           in: path
30810           description: Unique ID of the interface
30811           required: true
30812           type: string
30813           example: __INTERFACE-ID__
30814         - name: cvlan-tag
30815           in: path
30816           description: See mis-na-virtualization-platform.yang
30817           required: true
30818           type: integer
30819           format: int64
30820           example: __CVLAN-TAG__
30821   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
30822     get:
30823       tags:
30824         - Network
30825       summary: returns cvlan-tag-entry
30826       description: returns cvlan-tag-entry
30827       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30828       produces:
30829         - application/json
30830         - application/xml
30831       responses:
30832         "200":
30833           description: successful operation
30834           schema:
30835               $ref: "#/getDefinitions/cvlan-tag-entry"
30836         "default":
30837           description: Response codes found in [response codes](https://wiki.onap.org/).
30838       parameters:
30839         - name: vnf-id
30840           in: path
30841           description: Unique id of VNF.  This is unique across the graph.
30842           required: true
30843           type: string
30844           example: __VNF-ID__
30845         - name: interface-id
30846           in: path
30847           description: Unique ID of the interface
30848           required: true
30849           type: string
30850           example: __INTERFACE-ID__
30851         - name: cvlan-tag
30852           in: path
30853           description: See mis-na-virtualization-platform.yang
30854           required: true
30855           type: integer
30856           format: int64
30857           example: __CVLAN-TAG__
30858         - name: vnf-name
30859           in: query
30860           description: Name of VNF.
30861           required: false
30862           type: string
30863         - name: vnf-name2
30864           in: query
30865           description: Alternate name of VNF.
30866           required: false
30867           type: string
30868         - name: vnf-type
30869           in: query
30870           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.
30871           required: false
30872           type: string
30873         - name: service-id
30874           in: query
30875           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30876           required: false
30877           type: string
30878         - name: regional-resource-zone
30879           in: query
30880           description: Regional way of organizing pservers, source of truth should define values
30881           required: false
30882           type: string
30883         - name: prov-status
30884           in: query
30885           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30886           required: false
30887           type: string
30888         - name: heat-stack-id
30889           in: query
30890           description: Heat stack id corresponding to this instance, managed by MSO
30891           required: false
30892           type: string
30893         - name: vpe-id
30894           in: query
30895           description: Unique ID of VPE connected to this VCE.
30896           required: false
30897           type: string
30898         - name: port-group-id
30899           in: query
30900           description: Unique ID for port group in vmware
30901           required: false
30902           type: string
30903         - name: switch-name
30904           in: query
30905           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30906           required: false
30907           type: string
30908         - name: heat-stack-id
30909           in: query
30910           description: Heat stack id corresponding to this instance, managed by MSO
30911           required: false
30912           type: string
30913     put:
30914       tags:
30915         - Network
30916       summary: create or update an existing cvlan-tag-entry
30917       description: |
30918         Create or update an existing cvlan-tag-entry.
30919         #
30920         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
30921       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30922       consumes:
30923         - application/json
30924         - application/xml
30925       produces:
30926         - application/json
30927         - application/xml
30928       responses:
30929         "default":
30930           description: Response codes found in [response codes](https://wiki.onap.org/).
30931       parameters:
30932         - name: vnf-id
30933           in: path
30934           description: Unique id of VNF.  This is unique across the graph.
30935           required: true
30936           type: string
30937           example: __VNF-ID__
30938         - name: interface-id
30939           in: path
30940           description: Unique ID of the interface
30941           required: true
30942           type: string
30943           example: __INTERFACE-ID__
30944         - name: cvlan-tag
30945           in: path
30946           description: See mis-na-virtualization-platform.yang
30947           required: true
30948           type: integer
30949           format: int64
30950           example: __CVLAN-TAG__
30951         - name: body
30952           in: body
30953           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
30954           required: true
30955           schema:
30956             $ref: "#/definitions/cvlan-tag-entry"
30957     patch:
30958       tags:
30959         - Network
30960       summary: update an existing cvlan-tag-entry
30961       description: |
30962         Update an existing cvlan-tag-entry
30963         #
30964         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30965         The PUT operation will entirely replace an existing object.
30966         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.
30967         #
30968         Other differences between PUT and PATCH are:
30969         #
30970         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30971         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30972         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30973       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30974       consumes:
30975         - application/json
30976         - application/xml
30977       produces:
30978         - application/json
30979         - application/xml
30980       responses:
30981         "default":
30982           description: Response codes found in [response codes](https://wiki.onap.org/).
30983       parameters:
30984         - name: vnf-id
30985           in: path
30986           description: Unique id of VNF.  This is unique across the graph.
30987           required: true
30988           type: string
30989           example: __VNF-ID__
30990         - name: interface-id
30991           in: path
30992           description: Unique ID of the interface
30993           required: true
30994           type: string
30995           example: __INTERFACE-ID__
30996         - name: cvlan-tag
30997           in: path
30998           description: See mis-na-virtualization-platform.yang
30999           required: true
31000           type: integer
31001           format: int64
31002           example: __CVLAN-TAG__
31003         - name: body
31004           in: body
31005           description: cvlan-tag-entry object that needs to be created or updated.
31006           required: true
31007           schema:
31008             $ref: "#/patchDefinitions/cvlan-tag-entry"
31009     delete:
31010       tags:
31011         - Network
31012       summary: delete an existing cvlan-tag-entry
31013       description: delete an existing cvlan-tag-entry
31014       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
31015       consumes:
31016         - application/json
31017         - application/xml
31018       produces:
31019         - application/json
31020         - application/xml
31021       responses:
31022         "default":
31023           description: Response codes found in [response codes](https://wiki.onap.org/).
31024       parameters:
31025         - name: vnf-id
31026           in: path
31027           description: Unique id of VNF.  This is unique across the graph.
31028           required: true
31029           type: string
31030           example: __VNF-ID__
31031         - name: interface-id
31032           in: path
31033           description: Unique ID of the interface
31034           required: true
31035           type: string
31036           example: __INTERFACE-ID__
31037         - name: cvlan-tag
31038           in: path
31039           description: See mis-na-virtualization-platform.yang
31040           required: true
31041           type: integer
31042           format: int64
31043           example: __CVLAN-TAG__
31044         - name: resource-version
31045           in: query
31046           description: resource-version for concurrency
31047           required: true
31048           type: string
31049   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
31050     get:
31051       tags:
31052         - Network
31053       summary: returns cvlan-tags
31054       description: returns cvlan-tags
31055       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
31056       produces:
31057         - application/json
31058         - application/xml
31059       responses:
31060         "200":
31061           description: successful operation
31062           schema:
31063               $ref: "#/getDefinitions/cvlan-tags"
31064         "default":
31065           description: Response codes found in [response codes](https://wiki.onap.org/).
31066       parameters:
31067         - name: vnf-id
31068           in: path
31069           description: Unique id of VNF.  This is unique across the graph.
31070           required: true
31071           type: string
31072           example: __VNF-ID__
31073         - name: interface-id
31074           in: path
31075           description: Unique ID of the interface
31076           required: true
31077           type: string
31078           example: __INTERFACE-ID__
31079         - name: vnf-name
31080           in: query
31081           description: Name of VNF.
31082           required: false
31083           type: string
31084         - name: vnf-name2
31085           in: query
31086           description: Alternate name of VNF.
31087           required: false
31088           type: string
31089         - name: vnf-type
31090           in: query
31091           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.
31092           required: false
31093           type: string
31094         - name: service-id
31095           in: query
31096           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31097           required: false
31098           type: string
31099         - name: regional-resource-zone
31100           in: query
31101           description: Regional way of organizing pservers, source of truth should define values
31102           required: false
31103           type: string
31104         - name: prov-status
31105           in: query
31106           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31107           required: false
31108           type: string
31109         - name: heat-stack-id
31110           in: query
31111           description: Heat stack id corresponding to this instance, managed by MSO
31112           required: false
31113           type: string
31114         - name: vpe-id
31115           in: query
31116           description: Unique ID of VPE connected to this VCE.
31117           required: false
31118           type: string
31119         - name: port-group-id
31120           in: query
31121           description: Unique ID for port group in vmware
31122           required: false
31123           type: string
31124         - name: switch-name
31125           in: query
31126           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
31127           required: false
31128           type: string
31129         - name: heat-stack-id
31130           in: query
31131           description: Heat stack id corresponding to this instance, managed by MSO
31132           required: false
31133           type: string
31134   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
31135     put:
31136       tags:
31137         - Network
31138       summary: see node definition for valid relationships
31139       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
31140       consumes:
31141         - application/json
31142         - application/xml
31143       produces:
31144         - application/json
31145         - application/xml
31146       responses:
31147         "default":
31148           description: Response codes found in [response codes](https://wiki.onap.org/).
31149       parameters:
31150         - name: vnf-id
31151           in: path
31152           description: Unique id of VNF.  This is unique across the graph.
31153           required: true
31154           type: string
31155           example: __VNF-ID__
31156         - name: interface-id
31157           in: path
31158           description: Unique ID of the interface
31159           required: true
31160           type: string
31161           example: __INTERFACE-ID__
31162         - name: body
31163           in: body
31164           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
31165           required: true
31166           schema:
31167             $ref: "#/definitions/relationship"
31168     delete:
31169       tags:
31170         - Network
31171       summary: delete an existing relationship
31172       description: delete an existing relationship
31173       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
31174       consumes:
31175         - application/json
31176         - application/xml
31177       produces:
31178         - application/json
31179         - application/xml
31180       responses:
31181         "default":
31182           description: Response codes found in [response codes](https://wiki.onap.org/).
31183       parameters:
31184         - name: vnf-id
31185           in: path
31186           description: Unique id of VNF.  This is unique across the graph.
31187           required: true
31188           type: string
31189           example: __VNF-ID__
31190         - name: interface-id
31191           in: path
31192           description: Unique ID of the interface
31193           required: true
31194           type: string
31195           example: __INTERFACE-ID__
31196   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
31197     get:
31198       tags:
31199         - Network
31200       summary: returns port-group
31201       description: returns port-group
31202       operationId: getNetworkVcesVcePortGroupsPortGroup
31203       produces:
31204         - application/json
31205         - application/xml
31206       responses:
31207         "200":
31208           description: successful operation
31209           schema:
31210               $ref: "#/getDefinitions/port-group"
31211         "default":
31212           description: Response codes found in [response codes](https://wiki.onap.org/).
31213       parameters:
31214         - name: vnf-id
31215           in: path
31216           description: Unique id of VNF.  This is unique across the graph.
31217           required: true
31218           type: string
31219           example: __VNF-ID__
31220         - name: interface-id
31221           in: path
31222           description: Unique ID of the interface
31223           required: true
31224           type: string
31225           example: __INTERFACE-ID__
31226         - name: vnf-name
31227           in: query
31228           description: Name of VNF.
31229           required: false
31230           type: string
31231         - name: vnf-name2
31232           in: query
31233           description: Alternate name of VNF.
31234           required: false
31235           type: string
31236         - name: vnf-type
31237           in: query
31238           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.
31239           required: false
31240           type: string
31241         - name: service-id
31242           in: query
31243           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31244           required: false
31245           type: string
31246         - name: regional-resource-zone
31247           in: query
31248           description: Regional way of organizing pservers, source of truth should define values
31249           required: false
31250           type: string
31251         - name: prov-status
31252           in: query
31253           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31254           required: false
31255           type: string
31256         - name: heat-stack-id
31257           in: query
31258           description: Heat stack id corresponding to this instance, managed by MSO
31259           required: false
31260           type: string
31261         - name: vpe-id
31262           in: query
31263           description: Unique ID of VPE connected to this VCE.
31264           required: false
31265           type: string
31266         - name: port-group-id
31267           in: query
31268           description: Unique ID for port group in vmware
31269           required: false
31270           type: string
31271         - name: switch-name
31272           in: query
31273           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
31274           required: false
31275           type: string
31276         - name: heat-stack-id
31277           in: query
31278           description: Heat stack id corresponding to this instance, managed by MSO
31279           required: false
31280           type: string
31281     put:
31282       tags:
31283         - Network
31284       summary: create or update an existing port-group
31285       description: |
31286         Create or update an existing port-group.
31287         #
31288         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
31289       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
31290       consumes:
31291         - application/json
31292         - application/xml
31293       produces:
31294         - application/json
31295         - application/xml
31296       responses:
31297         "default":
31298           description: Response codes found in [response codes](https://wiki.onap.org/).
31299       parameters:
31300         - name: vnf-id
31301           in: path
31302           description: Unique id of VNF.  This is unique across the graph.
31303           required: true
31304           type: string
31305           example: __VNF-ID__
31306         - name: interface-id
31307           in: path
31308           description: Unique ID of the interface
31309           required: true
31310           type: string
31311           example: __INTERFACE-ID__
31312         - name: body
31313           in: body
31314           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
31315           required: true
31316           schema:
31317             $ref: "#/definitions/port-group"
31318     patch:
31319       tags:
31320         - Network
31321       summary: update an existing port-group
31322       description: |
31323         Update an existing port-group
31324         #
31325         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31326         The PUT operation will entirely replace an existing object.
31327         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.
31328         #
31329         Other differences between PUT and PATCH are:
31330         #
31331         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31332         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31333         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31334       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
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-id
31352           in: path
31353           description: Unique ID of the interface
31354           required: true
31355           type: string
31356           example: __INTERFACE-ID__
31357         - name: body
31358           in: body
31359           description: port-group object that needs to be created or updated.
31360           required: true
31361           schema:
31362             $ref: "#/patchDefinitions/port-group"
31363     delete:
31364       tags:
31365         - Network
31366       summary: delete an existing port-group
31367       description: delete an existing port-group
31368       operationId: deleteNetworkVcesVcePortGroupsPortGroup
31369       consumes:
31370         - application/json
31371         - application/xml
31372       produces:
31373         - application/json
31374         - application/xml
31375       responses:
31376         "default":
31377           description: Response codes found in [response codes](https://wiki.onap.org/).
31378       parameters:
31379         - name: vnf-id
31380           in: path
31381           description: Unique id of VNF.  This is unique across the graph.
31382           required: true
31383           type: string
31384           example: __VNF-ID__
31385         - name: interface-id
31386           in: path
31387           description: Unique ID of the interface
31388           required: true
31389           type: string
31390           example: __INTERFACE-ID__
31391         - name: resource-version
31392           in: query
31393           description: resource-version for concurrency
31394           required: true
31395           type: string
31396   /network/vces/vce/{vnf-id}/port-groups:
31397     get:
31398       tags:
31399         - Network
31400       summary: returns port-groups
31401       description: returns port-groups
31402       operationId: getNetworkVcesVcePortGroups
31403       produces:
31404         - application/json
31405         - application/xml
31406       responses:
31407         "200":
31408           description: successful operation
31409           schema:
31410               $ref: "#/getDefinitions/port-groups"
31411         "default":
31412           description: Response codes found in [response codes](https://wiki.onap.org/).
31413       parameters:
31414         - name: vnf-id
31415           in: path
31416           description: Unique id of VNF.  This is unique across the graph.
31417           required: true
31418           type: string
31419           example: __VNF-ID__
31420         - name: vnf-name
31421           in: query
31422           description: Name of VNF.
31423           required: false
31424           type: string
31425         - name: vnf-name2
31426           in: query
31427           description: Alternate name of VNF.
31428           required: false
31429           type: string
31430         - name: vnf-type
31431           in: query
31432           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.
31433           required: false
31434           type: string
31435         - name: service-id
31436           in: query
31437           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31438           required: false
31439           type: string
31440         - name: regional-resource-zone
31441           in: query
31442           description: Regional way of organizing pservers, source of truth should define values
31443           required: false
31444           type: string
31445         - name: prov-status
31446           in: query
31447           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31448           required: false
31449           type: string
31450         - name: heat-stack-id
31451           in: query
31452           description: Heat stack id corresponding to this instance, managed by MSO
31453           required: false
31454           type: string
31455         - name: vpe-id
31456           in: query
31457           description: Unique ID of VPE connected to this VCE.
31458           required: false
31459           type: string
31460   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31461     put:
31462       tags:
31463         - Network
31464       summary: see node definition for valid relationships
31465       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
31466       consumes:
31467         - application/json
31468         - application/xml
31469       produces:
31470         - application/json
31471         - application/xml
31472       responses:
31473         "default":
31474           description: Response codes found in [response codes](https://wiki.onap.org/).
31475       parameters:
31476         - name: vnf-id
31477           in: path
31478           description: Unique id of VNF.  This is unique across the graph.
31479           required: true
31480           type: string
31481           example: __VNF-ID__
31482         - name: group-uuid
31483           in: path
31484           description: Unique ID for the license group the resource belongs to, should be uuid.
31485           required: true
31486           type: string
31487           example: __GROUP-UUID__
31488         - name: resource-uuid
31489           in: path
31490           description: Unique ID of a license resource.
31491           required: true
31492           type: string
31493           example: __RESOURCE-UUID__
31494         - name: body
31495           in: body
31496           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
31497           required: true
31498           schema:
31499             $ref: "#/definitions/relationship"
31500     delete:
31501       tags:
31502         - Network
31503       summary: delete an existing relationship
31504       description: delete an existing relationship
31505       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
31506       consumes:
31507         - application/json
31508         - application/xml
31509       produces:
31510         - application/json
31511         - application/xml
31512       responses:
31513         "default":
31514           description: Response codes found in [response codes](https://wiki.onap.org/).
31515       parameters:
31516         - name: vnf-id
31517           in: path
31518           description: Unique id of VNF.  This is unique across the graph.
31519           required: true
31520           type: string
31521           example: __VNF-ID__
31522         - name: group-uuid
31523           in: path
31524           description: Unique ID for the license group the resource belongs to, should be uuid.
31525           required: true
31526           type: string
31527           example: __GROUP-UUID__
31528         - name: resource-uuid
31529           in: path
31530           description: Unique ID of a license resource.
31531           required: true
31532           type: string
31533           example: __RESOURCE-UUID__
31534   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
31535     get:
31536       tags:
31537         - Network
31538       summary: returns license
31539       description: returns license
31540       operationId: getNetworkVcesVceLicensesLicense
31541       produces:
31542         - application/json
31543         - application/xml
31544       responses:
31545         "200":
31546           description: successful operation
31547           schema:
31548               $ref: "#/getDefinitions/license"
31549         "default":
31550           description: Response codes found in [response codes](https://wiki.onap.org/).
31551       parameters:
31552         - name: vnf-id
31553           in: path
31554           description: Unique id of VNF.  This is unique across the graph.
31555           required: true
31556           type: string
31557           example: __VNF-ID__
31558         - name: group-uuid
31559           in: path
31560           description: Unique ID for the license group the resource belongs to, should be uuid.
31561           required: true
31562           type: string
31563           example: __GROUP-UUID__
31564         - name: resource-uuid
31565           in: path
31566           description: Unique ID of a license resource.
31567           required: true
31568           type: string
31569           example: __RESOURCE-UUID__
31570         - name: vnf-name
31571           in: query
31572           description: Name of VNF.
31573           required: false
31574           type: string
31575         - name: vnf-name2
31576           in: query
31577           description: Alternate name of VNF.
31578           required: false
31579           type: string
31580         - name: vnf-type
31581           in: query
31582           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.
31583           required: false
31584           type: string
31585         - name: service-id
31586           in: query
31587           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31588           required: false
31589           type: string
31590         - name: regional-resource-zone
31591           in: query
31592           description: Regional way of organizing pservers, source of truth should define values
31593           required: false
31594           type: string
31595         - name: prov-status
31596           in: query
31597           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31598           required: false
31599           type: string
31600         - name: heat-stack-id
31601           in: query
31602           description: Heat stack id corresponding to this instance, managed by MSO
31603           required: false
31604           type: string
31605         - name: vpe-id
31606           in: query
31607           description: Unique ID of VPE connected to this VCE.
31608           required: false
31609           type: string
31610     put:
31611       tags:
31612         - Network
31613       summary: create or update an existing license
31614       description: |
31615         Create or update an existing license.
31616         #
31617         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
31618       operationId: createOrUpdateNetworkVcesVceLicensesLicense
31619       consumes:
31620         - application/json
31621         - application/xml
31622       produces:
31623         - application/json
31624         - application/xml
31625       responses:
31626         "default":
31627           description: Response codes found in [response codes](https://wiki.onap.org/).
31628       parameters:
31629         - name: vnf-id
31630           in: path
31631           description: Unique id of VNF.  This is unique across the graph.
31632           required: true
31633           type: string
31634           example: __VNF-ID__
31635         - name: group-uuid
31636           in: path
31637           description: Unique ID for the license group the resource belongs to, should be uuid.
31638           required: true
31639           type: string
31640           example: __GROUP-UUID__
31641         - name: resource-uuid
31642           in: path
31643           description: Unique ID of a license resource.
31644           required: true
31645           type: string
31646           example: __RESOURCE-UUID__
31647         - name: body
31648           in: body
31649           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
31650           required: true
31651           schema:
31652             $ref: "#/definitions/license"
31653     patch:
31654       tags:
31655         - Network
31656       summary: update an existing license
31657       description: |
31658         Update an existing license
31659         #
31660         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31661         The PUT operation will entirely replace an existing object.
31662         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.
31663         #
31664         Other differences between PUT and PATCH are:
31665         #
31666         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31667         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31668         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31669       operationId: UpdateNetworkVcesVceLicensesLicense
31670       consumes:
31671         - application/json
31672         - application/xml
31673       produces:
31674         - application/json
31675         - application/xml
31676       responses:
31677         "default":
31678           description: Response codes found in [response codes](https://wiki.onap.org/).
31679       parameters:
31680         - name: vnf-id
31681           in: path
31682           description: Unique id of VNF.  This is unique across the graph.
31683           required: true
31684           type: string
31685           example: __VNF-ID__
31686         - name: group-uuid
31687           in: path
31688           description: Unique ID for the license group the resource belongs to, should be uuid.
31689           required: true
31690           type: string
31691           example: __GROUP-UUID__
31692         - name: resource-uuid
31693           in: path
31694           description: Unique ID of a license resource.
31695           required: true
31696           type: string
31697           example: __RESOURCE-UUID__
31698         - name: body
31699           in: body
31700           description: license object that needs to be created or updated.
31701           required: true
31702           schema:
31703             $ref: "#/patchDefinitions/license"
31704     delete:
31705       tags:
31706         - Network
31707       summary: delete an existing license
31708       description: delete an existing license
31709       operationId: deleteNetworkVcesVceLicensesLicense
31710       consumes:
31711         - application/json
31712         - application/xml
31713       produces:
31714         - application/json
31715         - application/xml
31716       responses:
31717         "default":
31718           description: Response codes found in [response codes](https://wiki.onap.org/).
31719       parameters:
31720         - name: vnf-id
31721           in: path
31722           description: Unique id of VNF.  This is unique across the graph.
31723           required: true
31724           type: string
31725           example: __VNF-ID__
31726         - name: group-uuid
31727           in: path
31728           description: Unique ID for the license group the resource belongs to, should be uuid.
31729           required: true
31730           type: string
31731           example: __GROUP-UUID__
31732         - name: resource-uuid
31733           in: path
31734           description: Unique ID of a license resource.
31735           required: true
31736           type: string
31737           example: __RESOURCE-UUID__
31738         - name: resource-version
31739           in: query
31740           description: resource-version for concurrency
31741           required: true
31742           type: string
31743   /network/vces/vce/{vnf-id}/licenses:
31744     get:
31745       tags:
31746         - Network
31747       summary: returns licenses
31748       description: returns licenses
31749       operationId: getNetworkVcesVceLicenses
31750       produces:
31751         - application/json
31752         - application/xml
31753       responses:
31754         "200":
31755           description: successful operation
31756           schema:
31757               $ref: "#/getDefinitions/licenses"
31758         "default":
31759           description: Response codes found in [response codes](https://wiki.onap.org/).
31760       parameters:
31761         - name: vnf-id
31762           in: path
31763           description: Unique id of VNF.  This is unique across the graph.
31764           required: true
31765           type: string
31766           example: __VNF-ID__
31767         - name: vnf-name
31768           in: query
31769           description: Name of VNF.
31770           required: false
31771           type: string
31772         - name: vnf-name2
31773           in: query
31774           description: Alternate name of VNF.
31775           required: false
31776           type: string
31777         - name: vnf-type
31778           in: query
31779           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.
31780           required: false
31781           type: string
31782         - name: service-id
31783           in: query
31784           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31785           required: false
31786           type: string
31787         - name: regional-resource-zone
31788           in: query
31789           description: Regional way of organizing pservers, source of truth should define values
31790           required: false
31791           type: string
31792         - name: prov-status
31793           in: query
31794           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31795           required: false
31796           type: string
31797         - name: heat-stack-id
31798           in: query
31799           description: Heat stack id corresponding to this instance, managed by MSO
31800           required: false
31801           type: string
31802         - name: vpe-id
31803           in: query
31804           description: Unique ID of VPE connected to this VCE.
31805           required: false
31806           type: string
31807   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31808     put:
31809       tags:
31810         - Network
31811       summary: see node definition for valid relationships
31812       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
31813       consumes:
31814         - application/json
31815         - application/xml
31816       produces:
31817         - application/json
31818         - application/xml
31819       responses:
31820         "default":
31821           description: Response codes found in [response codes](https://wiki.onap.org/).
31822       parameters:
31823         - name: vnf-id
31824           in: path
31825           description: Unique id of VNF.  This is unique across the graph.
31826           required: true
31827           type: string
31828           example: __VNF-ID__
31829         - name: group-uuid
31830           in: path
31831           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31832           required: true
31833           type: string
31834           example: __GROUP-UUID__
31835         - name: resource-uuid
31836           in: path
31837           description: Unique ID of an entitlement resource.
31838           required: true
31839           type: string
31840           example: __RESOURCE-UUID__
31841         - name: body
31842           in: body
31843           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
31844           required: true
31845           schema:
31846             $ref: "#/definitions/relationship"
31847     delete:
31848       tags:
31849         - Network
31850       summary: delete an existing relationship
31851       description: delete an existing relationship
31852       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
31853       consumes:
31854         - application/json
31855         - application/xml
31856       produces:
31857         - application/json
31858         - application/xml
31859       responses:
31860         "default":
31861           description: Response codes found in [response codes](https://wiki.onap.org/).
31862       parameters:
31863         - name: vnf-id
31864           in: path
31865           description: Unique id of VNF.  This is unique across the graph.
31866           required: true
31867           type: string
31868           example: __VNF-ID__
31869         - name: group-uuid
31870           in: path
31871           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31872           required: true
31873           type: string
31874           example: __GROUP-UUID__
31875         - name: resource-uuid
31876           in: path
31877           description: Unique ID of an entitlement resource.
31878           required: true
31879           type: string
31880           example: __RESOURCE-UUID__
31881   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
31882     get:
31883       tags:
31884         - Network
31885       summary: returns entitlement
31886       description: returns entitlement
31887       operationId: getNetworkVcesVceEntitlementsEntitlement
31888       produces:
31889         - application/json
31890         - application/xml
31891       responses:
31892         "200":
31893           description: successful operation
31894           schema:
31895               $ref: "#/getDefinitions/entitlement"
31896         "default":
31897           description: Response codes found in [response codes](https://wiki.onap.org/).
31898       parameters:
31899         - name: vnf-id
31900           in: path
31901           description: Unique id of VNF.  This is unique across the graph.
31902           required: true
31903           type: string
31904           example: __VNF-ID__
31905         - name: group-uuid
31906           in: path
31907           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31908           required: true
31909           type: string
31910           example: __GROUP-UUID__
31911         - name: resource-uuid
31912           in: path
31913           description: Unique ID of an entitlement resource.
31914           required: true
31915           type: string
31916           example: __RESOURCE-UUID__
31917         - name: vnf-name
31918           in: query
31919           description: Name of VNF.
31920           required: false
31921           type: string
31922         - name: vnf-name2
31923           in: query
31924           description: Alternate name of VNF.
31925           required: false
31926           type: string
31927         - name: vnf-type
31928           in: query
31929           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.
31930           required: false
31931           type: string
31932         - name: service-id
31933           in: query
31934           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31935           required: false
31936           type: string
31937         - name: regional-resource-zone
31938           in: query
31939           description: Regional way of organizing pservers, source of truth should define values
31940           required: false
31941           type: string
31942         - name: prov-status
31943           in: query
31944           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31945           required: false
31946           type: string
31947         - name: heat-stack-id
31948           in: query
31949           description: Heat stack id corresponding to this instance, managed by MSO
31950           required: false
31951           type: string
31952         - name: vpe-id
31953           in: query
31954           description: Unique ID of VPE connected to this VCE.
31955           required: false
31956           type: string
31957     put:
31958       tags:
31959         - Network
31960       summary: create or update an existing entitlement
31961       description: |
31962         Create or update an existing entitlement.
31963         #
31964         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
31965       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
31966       consumes:
31967         - application/json
31968         - application/xml
31969       produces:
31970         - application/json
31971         - application/xml
31972       responses:
31973         "default":
31974           description: Response codes found in [response codes](https://wiki.onap.org/).
31975       parameters:
31976         - name: vnf-id
31977           in: path
31978           description: Unique id of VNF.  This is unique across the graph.
31979           required: true
31980           type: string
31981           example: __VNF-ID__
31982         - name: group-uuid
31983           in: path
31984           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31985           required: true
31986           type: string
31987           example: __GROUP-UUID__
31988         - name: resource-uuid
31989           in: path
31990           description: Unique ID of an entitlement resource.
31991           required: true
31992           type: string
31993           example: __RESOURCE-UUID__
31994         - name: body
31995           in: body
31996           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
31997           required: true
31998           schema:
31999             $ref: "#/definitions/entitlement"
32000     patch:
32001       tags:
32002         - Network
32003       summary: update an existing entitlement
32004       description: |
32005         Update an existing entitlement
32006         #
32007         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32008         The PUT operation will entirely replace an existing object.
32009         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.
32010         #
32011         Other differences between PUT and PATCH are:
32012         #
32013         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32014         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32015         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32016       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
32017       consumes:
32018         - application/json
32019         - application/xml
32020       produces:
32021         - application/json
32022         - application/xml
32023       responses:
32024         "default":
32025           description: Response codes found in [response codes](https://wiki.onap.org/).
32026       parameters:
32027         - name: vnf-id
32028           in: path
32029           description: Unique id of VNF.  This is unique across the graph.
32030           required: true
32031           type: string
32032           example: __VNF-ID__
32033         - name: group-uuid
32034           in: path
32035           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32036           required: true
32037           type: string
32038           example: __GROUP-UUID__
32039         - name: resource-uuid
32040           in: path
32041           description: Unique ID of an entitlement resource.
32042           required: true
32043           type: string
32044           example: __RESOURCE-UUID__
32045         - name: body
32046           in: body
32047           description: entitlement object that needs to be created or updated.
32048           required: true
32049           schema:
32050             $ref: "#/patchDefinitions/entitlement"
32051     delete:
32052       tags:
32053         - Network
32054       summary: delete an existing entitlement
32055       description: delete an existing entitlement
32056       operationId: deleteNetworkVcesVceEntitlementsEntitlement
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: group-uuid
32074           in: path
32075           description: Unique ID for the entitlement group the resource comes from, should be uuid.
32076           required: true
32077           type: string
32078           example: __GROUP-UUID__
32079         - name: resource-uuid
32080           in: path
32081           description: Unique ID of an entitlement resource.
32082           required: true
32083           type: string
32084           example: __RESOURCE-UUID__
32085         - name: resource-version
32086           in: query
32087           description: resource-version for concurrency
32088           required: true
32089           type: string
32090   /network/vces/vce/{vnf-id}/entitlements:
32091     get:
32092       tags:
32093         - Network
32094       summary: returns entitlements
32095       description: returns entitlements
32096       operationId: getNetworkVcesVceEntitlements
32097       produces:
32098         - application/json
32099         - application/xml
32100       responses:
32101         "200":
32102           description: successful operation
32103           schema:
32104               $ref: "#/getDefinitions/entitlements"
32105         "default":
32106           description: Response codes found in [response codes](https://wiki.onap.org/).
32107       parameters:
32108         - name: vnf-id
32109           in: path
32110           description: Unique id of VNF.  This is unique across the graph.
32111           required: true
32112           type: string
32113           example: __VNF-ID__
32114         - name: vnf-name
32115           in: query
32116           description: Name of VNF.
32117           required: false
32118           type: string
32119         - name: vnf-name2
32120           in: query
32121           description: Alternate name of VNF.
32122           required: false
32123           type: string
32124         - name: vnf-type
32125           in: query
32126           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.
32127           required: false
32128           type: string
32129         - name: service-id
32130           in: query
32131           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
32132           required: false
32133           type: string
32134         - name: regional-resource-zone
32135           in: query
32136           description: Regional way of organizing pservers, source of truth should define values
32137           required: false
32138           type: string
32139         - name: prov-status
32140           in: query
32141           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32142           required: false
32143           type: string
32144         - name: heat-stack-id
32145           in: query
32146           description: Heat stack id corresponding to this instance, managed by MSO
32147           required: false
32148           type: string
32149         - name: vpe-id
32150           in: query
32151           description: Unique ID of VPE connected to this VCE.
32152           required: false
32153           type: string
32154   /network/vces/vce/{vnf-id}/relationship-list/relationship:
32155     put:
32156       tags:
32157         - Network
32158       summary: see node definition for valid relationships
32159       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
32160       consumes:
32161         - application/json
32162         - application/xml
32163       produces:
32164         - application/json
32165         - application/xml
32166       responses:
32167         "default":
32168           description: Response codes found in [response codes](https://wiki.onap.org/).
32169       parameters:
32170         - name: vnf-id
32171           in: path
32172           description: Unique id of VNF.  This is unique across the graph.
32173           required: true
32174           type: string
32175           example: __VNF-ID__
32176         - name: body
32177           in: body
32178           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
32179           required: true
32180           schema:
32181             $ref: "#/definitions/relationship"
32182     delete:
32183       tags:
32184         - Network
32185       summary: delete an existing relationship
32186       description: delete an existing relationship
32187       operationId: deleteNetworkVcesVceRelationshipListRelationship
32188       consumes:
32189         - application/json
32190         - application/xml
32191       produces:
32192         - application/json
32193         - application/xml
32194       responses:
32195         "default":
32196           description: Response codes found in [response codes](https://wiki.onap.org/).
32197       parameters:
32198         - name: vnf-id
32199           in: path
32200           description: Unique id of VNF.  This is unique across the graph.
32201           required: true
32202           type: string
32203           example: __VNF-ID__
32204   /network/vces/vce/{vnf-id}:
32205     get:
32206       tags:
32207         - Network
32208       summary: returns vce
32209       description: returns vce
32210       operationId: getNetworkVcesVce
32211       produces:
32212         - application/json
32213         - application/xml
32214       responses:
32215         "200":
32216           description: successful operation
32217           schema:
32218               $ref: "#/getDefinitions/vce"
32219         "default":
32220           description: Response codes found in [response codes](https://wiki.onap.org/).
32221       parameters:
32222         - name: vnf-id
32223           in: path
32224           description: Unique id of VNF.  This is unique across the graph.
32225           required: true
32226           type: string
32227           example: __VNF-ID__
32228         - name: vnf-name
32229           in: query
32230           description: Name of VNF.
32231           required: false
32232           type: string
32233         - name: vnf-name2
32234           in: query
32235           description: Alternate name of VNF.
32236           required: false
32237           type: string
32238         - name: vnf-type
32239           in: query
32240           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.
32241           required: false
32242           type: string
32243         - name: service-id
32244           in: query
32245           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
32246           required: false
32247           type: string
32248         - name: regional-resource-zone
32249           in: query
32250           description: Regional way of organizing pservers, source of truth should define values
32251           required: false
32252           type: string
32253         - name: prov-status
32254           in: query
32255           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32256           required: false
32257           type: string
32258         - name: heat-stack-id
32259           in: query
32260           description: Heat stack id corresponding to this instance, managed by MSO
32261           required: false
32262           type: string
32263         - name: vpe-id
32264           in: query
32265           description: Unique ID of VPE connected to this VCE.
32266           required: false
32267           type: string
32268     put:
32269       tags:
32270         - Network
32271       summary: create or update an existing vce
32272       description: |
32273         Create or update an existing vce.
32274         #
32275         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
32276       operationId: createOrUpdateNetworkVcesVce
32277       consumes:
32278         - application/json
32279         - application/xml
32280       produces:
32281         - application/json
32282         - application/xml
32283       responses:
32284         "default":
32285           description: Response codes found in [response codes](https://wiki.onap.org/).
32286       parameters:
32287         - name: vnf-id
32288           in: path
32289           description: Unique id of VNF.  This is unique across the graph.
32290           required: true
32291           type: string
32292           example: __VNF-ID__
32293         - name: body
32294           in: body
32295           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
32296           required: true
32297           schema:
32298             $ref: "#/definitions/vce"
32299     patch:
32300       tags:
32301         - Network
32302       summary: update an existing vce
32303       description: |
32304         Update an existing vce
32305         #
32306         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32307         The PUT operation will entirely replace an existing object.
32308         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.
32309         #
32310         Other differences between PUT and PATCH are:
32311         #
32312         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32313         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32314         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32315       operationId: UpdateNetworkVcesVce
32316       consumes:
32317         - application/json
32318         - application/xml
32319       produces:
32320         - application/json
32321         - application/xml
32322       responses:
32323         "default":
32324           description: Response codes found in [response codes](https://wiki.onap.org/).
32325       parameters:
32326         - name: vnf-id
32327           in: path
32328           description: Unique id of VNF.  This is unique across the graph.
32329           required: true
32330           type: string
32331           example: __VNF-ID__
32332         - name: body
32333           in: body
32334           description: vce object that needs to be created or updated.
32335           required: true
32336           schema:
32337             $ref: "#/patchDefinitions/vce"
32338     delete:
32339       tags:
32340         - Network
32341       summary: delete an existing vce
32342       description: delete an existing vce
32343       operationId: deleteNetworkVcesVce
32344       consumes:
32345         - application/json
32346         - application/xml
32347       produces:
32348         - application/json
32349         - application/xml
32350       responses:
32351         "default":
32352           description: Response codes found in [response codes](https://wiki.onap.org/).
32353       parameters:
32354         - name: vnf-id
32355           in: path
32356           description: Unique id of VNF.  This is unique across the graph.
32357           required: true
32358           type: string
32359           example: __VNF-ID__
32360         - name: resource-version
32361           in: query
32362           description: resource-version for concurrency
32363           required: true
32364           type: string
32365   /network/vces:
32366     get:
32367       tags:
32368         - Network
32369       summary: returns vces
32370       description: returns vces
32371       operationId: getNetworkVces
32372       produces:
32373         - application/json
32374         - application/xml
32375       responses:
32376         "200":
32377           description: successful operation
32378           schema:
32379               $ref: "#/getDefinitions/vces"
32380         "default":
32381           description: Response codes found in [response codes](https://wiki.onap.org/).
32382   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
32383     put:
32384       tags:
32385         - Network
32386       summary: see node definition for valid relationships
32387       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
32388       consumes:
32389         - application/json
32390         - application/xml
32391       produces:
32392         - application/json
32393         - application/xml
32394       responses:
32395         "default":
32396           description: Response codes found in [response codes](https://wiki.onap.org/).
32397       parameters:
32398         - name: vnfc-name
32399           in: path
32400           description: Unique ID of vnfc.
32401           required: true
32402           type: string
32403           example: __VNFC-NAME__
32404         - name: body
32405           in: body
32406           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
32407           required: true
32408           schema:
32409             $ref: "#/definitions/relationship"
32410     delete:
32411       tags:
32412         - Network
32413       summary: delete an existing relationship
32414       description: delete an existing relationship
32415       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
32416       consumes:
32417         - application/json
32418         - application/xml
32419       produces:
32420         - application/json
32421         - application/xml
32422       responses:
32423         "default":
32424           description: Response codes found in [response codes](https://wiki.onap.org/).
32425       parameters:
32426         - name: vnfc-name
32427           in: path
32428           description: Unique ID of vnfc.
32429           required: true
32430           type: string
32431           example: __VNFC-NAME__
32432   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32433     put:
32434       tags:
32435         - Network
32436       summary: see node definition for valid relationships
32437       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
32438       consumes:
32439         - application/json
32440         - application/xml
32441       produces:
32442         - application/json
32443         - application/xml
32444       responses:
32445         "default":
32446           description: Response codes found in [response codes](https://wiki.onap.org/).
32447       parameters:
32448         - name: vnfc-name
32449           in: path
32450           description: Unique ID of vnfc.
32451           required: true
32452           type: string
32453           example: __VNFC-NAME__
32454         - name: l3-interface-ipv4-address
32455           in: path
32456           description: IP address
32457           required: true
32458           type: string
32459           example: __L3-INTERFACE-IPV4-ADDRESS__
32460         - name: body
32461           in: body
32462           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
32463           required: true
32464           schema:
32465             $ref: "#/definitions/relationship"
32466     delete:
32467       tags:
32468         - Network
32469       summary: delete an existing relationship
32470       description: delete an existing relationship
32471       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
32472       consumes:
32473         - application/json
32474         - application/xml
32475       produces:
32476         - application/json
32477         - application/xml
32478       responses:
32479         "default":
32480           description: Response codes found in [response codes](https://wiki.onap.org/).
32481       parameters:
32482         - name: vnfc-name
32483           in: path
32484           description: Unique ID of vnfc.
32485           required: true
32486           type: string
32487           example: __VNFC-NAME__
32488         - name: l3-interface-ipv4-address
32489           in: path
32490           description: IP address
32491           required: true
32492           type: string
32493           example: __L3-INTERFACE-IPV4-ADDRESS__
32494   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32495     get:
32496       tags:
32497         - Network
32498       summary: returns l3-interface-ipv4-address-list
32499       description: returns l3-interface-ipv4-address-list
32500       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32501       produces:
32502         - application/json
32503         - application/xml
32504       responses:
32505         "200":
32506           description: successful operation
32507           schema:
32508               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32509         "default":
32510           description: Response codes found in [response codes](https://wiki.onap.org/).
32511       parameters:
32512         - name: vnfc-name
32513           in: path
32514           description: Unique ID of vnfc.
32515           required: true
32516           type: string
32517           example: __VNFC-NAME__
32518         - name: l3-interface-ipv4-address
32519           in: path
32520           description: IP address
32521           required: true
32522           type: string
32523           example: __L3-INTERFACE-IPV4-ADDRESS__
32524         - name: nfc-naming-code
32525           in: query
32526           description: Short code that is used in naming instances of the item being modeled
32527           required: false
32528           type: string
32529         - name: nfc-function
32530           in: query
32531           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32532           required: false
32533           type: string
32534         - name: prov-status
32535           in: query
32536           description: prov status of this vnfc
32537           required: false
32538           type: string
32539         - name: ipaddress-v4-oam-vip
32540           in: query
32541           description: Oam V4 vip address of this vnfc
32542           required: false
32543           type: string
32544         - name: in-maint
32545           in: query
32546           required: false
32547           type: boolean
32548         - name: is-closed-loop-disabled
32549           in: query
32550           required: false
32551           type: boolean
32552         - name: group-notation
32553           in: query
32554           description: Group notation of VNFC
32555           required: false
32556           type: string
32557         - name: model-invariant-id
32558           in: query
32559           description: the ASDC model id for this resource or service model.
32560           required: false
32561           type: string
32562         - name: model-version-id
32563           in: query
32564           description: the ASDC model version for this resource or service model.
32565           required: false
32566           type: string
32567         - name: vlan-id-inner
32568           in: query
32569           description: Inner VLAN tag
32570           required: false
32571           type: integer
32572           format: int64
32573         - name: neutron-network-id
32574           in: query
32575           description: Neutron network id of the interface that address belongs to
32576           required: false
32577           type: string
32578         - name: neutron-subnet-id
32579           in: query
32580           description: Neutron id of subnet that address belongs to
32581           required: false
32582           type: string
32583     put:
32584       tags:
32585         - Network
32586       summary: create or update an existing l3-interface-ipv4-address-list
32587       description: |
32588         Create or update an existing l3-interface-ipv4-address-list.
32589         #
32590         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
32591       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32592       consumes:
32593         - application/json
32594         - application/xml
32595       produces:
32596         - application/json
32597         - application/xml
32598       responses:
32599         "default":
32600           description: Response codes found in [response codes](https://wiki.onap.org/).
32601       parameters:
32602         - name: vnfc-name
32603           in: path
32604           description: Unique ID of vnfc.
32605           required: true
32606           type: string
32607           example: __VNFC-NAME__
32608         - name: l3-interface-ipv4-address
32609           in: path
32610           description: IP address
32611           required: true
32612           type: string
32613           example: __L3-INTERFACE-IPV4-ADDRESS__
32614         - name: body
32615           in: body
32616           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
32617           required: true
32618           schema:
32619             $ref: "#/definitions/l3-interface-ipv4-address-list"
32620     patch:
32621       tags:
32622         - Network
32623       summary: update an existing l3-interface-ipv4-address-list
32624       description: |
32625         Update an existing l3-interface-ipv4-address-list
32626         #
32627         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32628         The PUT operation will entirely replace an existing object.
32629         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.
32630         #
32631         Other differences between PUT and PATCH are:
32632         #
32633         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32634         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32635         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32636       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32637       consumes:
32638         - application/json
32639         - application/xml
32640       produces:
32641         - application/json
32642         - application/xml
32643       responses:
32644         "default":
32645           description: Response codes found in [response codes](https://wiki.onap.org/).
32646       parameters:
32647         - name: vnfc-name
32648           in: path
32649           description: Unique ID of vnfc.
32650           required: true
32651           type: string
32652           example: __VNFC-NAME__
32653         - name: l3-interface-ipv4-address
32654           in: path
32655           description: IP address
32656           required: true
32657           type: string
32658           example: __L3-INTERFACE-IPV4-ADDRESS__
32659         - name: body
32660           in: body
32661           description: l3-interface-ipv4-address-list object that needs to be created or updated.
32662           required: true
32663           schema:
32664             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32665     delete:
32666       tags:
32667         - Network
32668       summary: delete an existing l3-interface-ipv4-address-list
32669       description: delete an existing l3-interface-ipv4-address-list
32670       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
32671       consumes:
32672         - application/json
32673         - application/xml
32674       produces:
32675         - application/json
32676         - application/xml
32677       responses:
32678         "default":
32679           description: Response codes found in [response codes](https://wiki.onap.org/).
32680       parameters:
32681         - name: vnfc-name
32682           in: path
32683           description: Unique ID of vnfc.
32684           required: true
32685           type: string
32686           example: __VNFC-NAME__
32687         - name: l3-interface-ipv4-address
32688           in: path
32689           description: IP address
32690           required: true
32691           type: string
32692           example: __L3-INTERFACE-IPV4-ADDRESS__
32693         - name: resource-version
32694           in: query
32695           description: resource-version for concurrency
32696           required: true
32697           type: string
32698   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
32699     put:
32700       tags:
32701         - Network
32702       summary: see node definition for valid relationships
32703       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
32704       consumes:
32705         - application/json
32706         - application/xml
32707       produces:
32708         - application/json
32709         - application/xml
32710       responses:
32711         "default":
32712           description: Response codes found in [response codes](https://wiki.onap.org/).
32713       parameters:
32714         - name: vnfc-name
32715           in: path
32716           description: Unique ID of vnfc.
32717           required: true
32718           type: string
32719           example: __VNFC-NAME__
32720         - name: l3-interface-ipv6-address
32721           in: path
32722           description: IP address
32723           required: true
32724           type: string
32725           example: __L3-INTERFACE-IPV6-ADDRESS__
32726         - name: body
32727           in: body
32728           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
32729           required: true
32730           schema:
32731             $ref: "#/definitions/relationship"
32732     delete:
32733       tags:
32734         - Network
32735       summary: delete an existing relationship
32736       description: delete an existing relationship
32737       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
32738       consumes:
32739         - application/json
32740         - application/xml
32741       produces:
32742         - application/json
32743         - application/xml
32744       responses:
32745         "default":
32746           description: Response codes found in [response codes](https://wiki.onap.org/).
32747       parameters:
32748         - name: vnfc-name
32749           in: path
32750           description: Unique ID of vnfc.
32751           required: true
32752           type: string
32753           example: __VNFC-NAME__
32754         - name: l3-interface-ipv6-address
32755           in: path
32756           description: IP address
32757           required: true
32758           type: string
32759           example: __L3-INTERFACE-IPV6-ADDRESS__
32760   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32761     get:
32762       tags:
32763         - Network
32764       summary: returns l3-interface-ipv6-address-list
32765       description: returns l3-interface-ipv6-address-list
32766       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32767       produces:
32768         - application/json
32769         - application/xml
32770       responses:
32771         "200":
32772           description: successful operation
32773           schema:
32774               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32775         "default":
32776           description: Response codes found in [response codes](https://wiki.onap.org/).
32777       parameters:
32778         - name: vnfc-name
32779           in: path
32780           description: Unique ID of vnfc.
32781           required: true
32782           type: string
32783           example: __VNFC-NAME__
32784         - name: l3-interface-ipv6-address
32785           in: path
32786           description: IP address
32787           required: true
32788           type: string
32789           example: __L3-INTERFACE-IPV6-ADDRESS__
32790         - name: nfc-naming-code
32791           in: query
32792           description: Short code that is used in naming instances of the item being modeled
32793           required: false
32794           type: string
32795         - name: nfc-function
32796           in: query
32797           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32798           required: false
32799           type: string
32800         - name: prov-status
32801           in: query
32802           description: prov status of this vnfc
32803           required: false
32804           type: string
32805         - name: ipaddress-v4-oam-vip
32806           in: query
32807           description: Oam V4 vip address of this vnfc
32808           required: false
32809           type: string
32810         - name: in-maint
32811           in: query
32812           required: false
32813           type: boolean
32814         - name: is-closed-loop-disabled
32815           in: query
32816           required: false
32817           type: boolean
32818         - name: group-notation
32819           in: query
32820           description: Group notation of VNFC
32821           required: false
32822           type: string
32823         - name: model-invariant-id
32824           in: query
32825           description: the ASDC model id for this resource or service model.
32826           required: false
32827           type: string
32828         - name: model-version-id
32829           in: query
32830           description: the ASDC model version for this resource or service model.
32831           required: false
32832           type: string
32833         - name: vlan-id-inner
32834           in: query
32835           description: Inner VLAN tag
32836           required: false
32837           type: integer
32838           format: int64
32839         - name: neutron-network-id
32840           in: query
32841           description: Neutron network id of the interface that address belongs to
32842           required: false
32843           type: string
32844         - name: neutron-subnet-id
32845           in: query
32846           description: Neutron id of subnet that address belongs to
32847           required: false
32848           type: string
32849     put:
32850       tags:
32851         - Network
32852       summary: create or update an existing l3-interface-ipv6-address-list
32853       description: |
32854         Create or update an existing l3-interface-ipv6-address-list.
32855         #
32856         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
32857       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32858       consumes:
32859         - application/json
32860         - application/xml
32861       produces:
32862         - application/json
32863         - application/xml
32864       responses:
32865         "default":
32866           description: Response codes found in [response codes](https://wiki.onap.org/).
32867       parameters:
32868         - name: vnfc-name
32869           in: path
32870           description: Unique ID of vnfc.
32871           required: true
32872           type: string
32873           example: __VNFC-NAME__
32874         - name: l3-interface-ipv6-address
32875           in: path
32876           description: IP address
32877           required: true
32878           type: string
32879           example: __L3-INTERFACE-IPV6-ADDRESS__
32880         - name: body
32881           in: body
32882           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
32883           required: true
32884           schema:
32885             $ref: "#/definitions/l3-interface-ipv6-address-list"
32886     patch:
32887       tags:
32888         - Network
32889       summary: update an existing l3-interface-ipv6-address-list
32890       description: |
32891         Update an existing l3-interface-ipv6-address-list
32892         #
32893         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32894         The PUT operation will entirely replace an existing object.
32895         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.
32896         #
32897         Other differences between PUT and PATCH are:
32898         #
32899         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32900         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32901         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32902       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32903       consumes:
32904         - application/json
32905         - application/xml
32906       produces:
32907         - application/json
32908         - application/xml
32909       responses:
32910         "default":
32911           description: Response codes found in [response codes](https://wiki.onap.org/).
32912       parameters:
32913         - name: vnfc-name
32914           in: path
32915           description: Unique ID of vnfc.
32916           required: true
32917           type: string
32918           example: __VNFC-NAME__
32919         - name: l3-interface-ipv6-address
32920           in: path
32921           description: IP address
32922           required: true
32923           type: string
32924           example: __L3-INTERFACE-IPV6-ADDRESS__
32925         - name: body
32926           in: body
32927           description: l3-interface-ipv6-address-list object that needs to be created or updated.
32928           required: true
32929           schema:
32930             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32931     delete:
32932       tags:
32933         - Network
32934       summary: delete an existing l3-interface-ipv6-address-list
32935       description: delete an existing l3-interface-ipv6-address-list
32936       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32937       consumes:
32938         - application/json
32939         - application/xml
32940       produces:
32941         - application/json
32942         - application/xml
32943       responses:
32944         "default":
32945           description: Response codes found in [response codes](https://wiki.onap.org/).
32946       parameters:
32947         - name: vnfc-name
32948           in: path
32949           description: Unique ID of vnfc.
32950           required: true
32951           type: string
32952           example: __VNFC-NAME__
32953         - name: l3-interface-ipv6-address
32954           in: path
32955           description: IP address
32956           required: true
32957           type: string
32958           example: __L3-INTERFACE-IPV6-ADDRESS__
32959         - name: resource-version
32960           in: query
32961           description: resource-version for concurrency
32962           required: true
32963           type: string
32964   /network/vnfcs/vnfc/{vnfc-name}:
32965     get:
32966       tags:
32967         - Network
32968       summary: returns vnfc
32969       description: returns vnfc
32970       operationId: getNetworkVnfcsVnfc
32971       produces:
32972         - application/json
32973         - application/xml
32974       responses:
32975         "200":
32976           description: successful operation
32977           schema:
32978               $ref: "#/getDefinitions/vnfc"
32979         "default":
32980           description: Response codes found in [response codes](https://wiki.onap.org/).
32981       parameters:
32982         - name: vnfc-name
32983           in: path
32984           description: Unique ID of vnfc.
32985           required: true
32986           type: string
32987           example: __VNFC-NAME__
32988         - name: nfc-naming-code
32989           in: query
32990           description: Short code that is used in naming instances of the item being modeled
32991           required: false
32992           type: string
32993         - name: nfc-function
32994           in: query
32995           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32996           required: false
32997           type: string
32998         - name: prov-status
32999           in: query
33000           description: prov status of this vnfc
33001           required: false
33002           type: string
33003         - name: ipaddress-v4-oam-vip
33004           in: query
33005           description: Oam V4 vip address of this vnfc
33006           required: false
33007           type: string
33008         - name: in-maint
33009           in: query
33010           required: false
33011           type: boolean
33012         - name: is-closed-loop-disabled
33013           in: query
33014           required: false
33015           type: boolean
33016         - name: group-notation
33017           in: query
33018           description: Group notation of VNFC
33019           required: false
33020           type: string
33021         - name: model-invariant-id
33022           in: query
33023           description: the ASDC model id for this resource or service model.
33024           required: false
33025           type: string
33026         - name: model-version-id
33027           in: query
33028           description: the ASDC model version for this resource or service model.
33029           required: false
33030           type: string
33031     put:
33032       tags:
33033         - Network
33034       summary: create or update an existing vnfc
33035       description: |
33036         Create or update an existing vnfc.
33037         #
33038         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
33039       operationId: createOrUpdateNetworkVnfcsVnfc
33040       consumes:
33041         - application/json
33042         - application/xml
33043       produces:
33044         - application/json
33045         - application/xml
33046       responses:
33047         "default":
33048           description: Response codes found in [response codes](https://wiki.onap.org/).
33049       parameters:
33050         - name: vnfc-name
33051           in: path
33052           description: Unique ID of vnfc.
33053           required: true
33054           type: string
33055           example: __VNFC-NAME__
33056         - name: body
33057           in: body
33058           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
33059           required: true
33060           schema:
33061             $ref: "#/definitions/vnfc"
33062     patch:
33063       tags:
33064         - Network
33065       summary: update an existing vnfc
33066       description: |
33067         Update an existing vnfc
33068         #
33069         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33070         The PUT operation will entirely replace an existing object.
33071         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.
33072         #
33073         Other differences between PUT and PATCH are:
33074         #
33075         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33076         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33077         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33078       operationId: UpdateNetworkVnfcsVnfc
33079       consumes:
33080         - application/json
33081         - application/xml
33082       produces:
33083         - application/json
33084         - application/xml
33085       responses:
33086         "default":
33087           description: Response codes found in [response codes](https://wiki.onap.org/).
33088       parameters:
33089         - name: vnfc-name
33090           in: path
33091           description: Unique ID of vnfc.
33092           required: true
33093           type: string
33094           example: __VNFC-NAME__
33095         - name: body
33096           in: body
33097           description: vnfc object that needs to be created or updated.
33098           required: true
33099           schema:
33100             $ref: "#/patchDefinitions/vnfc"
33101     delete:
33102       tags:
33103         - Network
33104       summary: delete an existing vnfc
33105       description: delete an existing vnfc
33106       operationId: deleteNetworkVnfcsVnfc
33107       consumes:
33108         - application/json
33109         - application/xml
33110       produces:
33111         - application/json
33112         - application/xml
33113       responses:
33114         "default":
33115           description: Response codes found in [response codes](https://wiki.onap.org/).
33116       parameters:
33117         - name: vnfc-name
33118           in: path
33119           description: Unique ID of vnfc.
33120           required: true
33121           type: string
33122           example: __VNFC-NAME__
33123         - name: resource-version
33124           in: query
33125           description: resource-version for concurrency
33126           required: true
33127           type: string
33128   /network/vnfcs:
33129     get:
33130       tags:
33131         - Network
33132       summary: returns vnfcs
33133       description: returns vnfcs
33134       operationId: getNetworkVnfcs
33135       produces:
33136         - application/json
33137         - application/xml
33138       responses:
33139         "200":
33140           description: successful operation
33141           schema:
33142               $ref: "#/getDefinitions/vnfcs"
33143         "default":
33144           description: Response codes found in [response codes](https://wiki.onap.org/).
33145   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
33146     put:
33147       tags:
33148         - Network
33149       summary: see node definition for valid relationships
33150       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
33151       consumes:
33152         - application/json
33153         - application/xml
33154       produces:
33155         - application/json
33156         - application/xml
33157       responses:
33158         "default":
33159           description: Response codes found in [response codes](https://wiki.onap.org/).
33160       parameters:
33161         - name: network-id
33162           in: path
33163           description: Network ID, should be uuid. Unique across A&AI.
33164           required: true
33165           type: string
33166           example: __NETWORK-ID__
33167         - name: subnet-id
33168           in: path
33169           description: Subnet ID, should be UUID.
33170           required: true
33171           type: string
33172           example: __SUBNET-ID__
33173         - name: host-route-id
33174           in: path
33175           description: host-route id
33176           required: true
33177           type: string
33178           example: __HOST-ROUTE-ID__
33179         - name: body
33180           in: body
33181           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
33182           required: true
33183           schema:
33184             $ref: "#/definitions/relationship"
33185     delete:
33186       tags:
33187         - Network
33188       summary: delete an existing relationship
33189       description: delete an existing relationship
33190       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
33191       consumes:
33192         - application/json
33193         - application/xml
33194       produces:
33195         - application/json
33196         - application/xml
33197       responses:
33198         "default":
33199           description: Response codes found in [response codes](https://wiki.onap.org/).
33200       parameters:
33201         - name: network-id
33202           in: path
33203           description: Network ID, should be uuid. Unique across A&AI.
33204           required: true
33205           type: string
33206           example: __NETWORK-ID__
33207         - name: subnet-id
33208           in: path
33209           description: Subnet ID, should be UUID.
33210           required: true
33211           type: string
33212           example: __SUBNET-ID__
33213         - name: host-route-id
33214           in: path
33215           description: host-route id
33216           required: true
33217           type: string
33218           example: __HOST-ROUTE-ID__
33219   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
33220     get:
33221       tags:
33222         - Network
33223       summary: returns host-route
33224       description: returns host-route
33225       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33226       produces:
33227         - application/json
33228         - application/xml
33229       responses:
33230         "200":
33231           description: successful operation
33232           schema:
33233               $ref: "#/getDefinitions/host-route"
33234         "default":
33235           description: Response codes found in [response codes](https://wiki.onap.org/).
33236       parameters:
33237         - name: network-id
33238           in: path
33239           description: Network ID, should be uuid. Unique across A&AI.
33240           required: true
33241           type: string
33242           example: __NETWORK-ID__
33243         - name: subnet-id
33244           in: path
33245           description: Subnet ID, should be UUID.
33246           required: true
33247           type: string
33248           example: __SUBNET-ID__
33249         - name: host-route-id
33250           in: path
33251           description: host-route id
33252           required: true
33253           type: string
33254           example: __HOST-ROUTE-ID__
33255         - name: network-name
33256           in: query
33257           description: Name of the network, governed by some naming convention..
33258           required: false
33259           type: string
33260         - name: network-role
33261           in: query
33262           description: Role the network plans - who defines these values?
33263           required: false
33264           type: string
33265         - name: service-id
33266           in: query
33267           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33268           required: false
33269           type: string
33270         - name: heat-stack-id
33271           in: query
33272           description: Heat stack id corresponding to this instance, managed by MSO
33273           required: false
33274           type: string
33275         - name: contrail-network-fqdn
33276           in: query
33277           description: Contrail FQDN for the network
33278           required: false
33279           type: string
33280         - name: model-invariant-id
33281           in: query
33282           description: the ASDC model id for this resource or service model.
33283           required: false
33284           type: string
33285         - name: model-version-id
33286           in: query
33287           description: the ASDC model version for this resource or service model.
33288           required: false
33289           type: string
33290         - name: widget-model-id
33291           in: query
33292           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33293           required: false
33294           type: string
33295         - name: widget-model-version
33296           in: query
33297           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33298           required: false
33299           type: string
33300         - name: subnet-name
33301           in: query
33302           description: Name associated with the subnet.
33303           required: false
33304           type: string
33305     put:
33306       tags:
33307         - Network
33308       summary: create or update an existing host-route
33309       description: |
33310         Create or update an existing host-route.
33311         #
33312         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
33313       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33314       consumes:
33315         - application/json
33316         - application/xml
33317       produces:
33318         - application/json
33319         - application/xml
33320       responses:
33321         "default":
33322           description: Response codes found in [response codes](https://wiki.onap.org/).
33323       parameters:
33324         - name: network-id
33325           in: path
33326           description: Network ID, should be uuid. Unique across A&AI.
33327           required: true
33328           type: string
33329           example: __NETWORK-ID__
33330         - name: subnet-id
33331           in: path
33332           description: Subnet ID, should be UUID.
33333           required: true
33334           type: string
33335           example: __SUBNET-ID__
33336         - name: host-route-id
33337           in: path
33338           description: host-route id
33339           required: true
33340           type: string
33341           example: __HOST-ROUTE-ID__
33342         - name: body
33343           in: body
33344           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
33345           required: true
33346           schema:
33347             $ref: "#/definitions/host-route"
33348     patch:
33349       tags:
33350         - Network
33351       summary: update an existing host-route
33352       description: |
33353         Update an existing host-route
33354         #
33355         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33356         The PUT operation will entirely replace an existing object.
33357         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.
33358         #
33359         Other differences between PUT and PATCH are:
33360         #
33361         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33362         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33363         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33364       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
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: network-id
33376           in: path
33377           description: Network ID, should be uuid. Unique across A&AI.
33378           required: true
33379           type: string
33380           example: __NETWORK-ID__
33381         - name: subnet-id
33382           in: path
33383           description: Subnet ID, should be UUID.
33384           required: true
33385           type: string
33386           example: __SUBNET-ID__
33387         - name: host-route-id
33388           in: path
33389           description: host-route id
33390           required: true
33391           type: string
33392           example: __HOST-ROUTE-ID__
33393         - name: body
33394           in: body
33395           description: host-route object that needs to be created or updated.
33396           required: true
33397           schema:
33398             $ref: "#/patchDefinitions/host-route"
33399     delete:
33400       tags:
33401         - Network
33402       summary: delete an existing host-route
33403       description: delete an existing host-route
33404       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
33405       consumes:
33406         - application/json
33407         - application/xml
33408       produces:
33409         - application/json
33410         - application/xml
33411       responses:
33412         "default":
33413           description: Response codes found in [response codes](https://wiki.onap.org/).
33414       parameters:
33415         - name: network-id
33416           in: path
33417           description: Network ID, should be uuid. Unique across A&AI.
33418           required: true
33419           type: string
33420           example: __NETWORK-ID__
33421         - name: subnet-id
33422           in: path
33423           description: Subnet ID, should be UUID.
33424           required: true
33425           type: string
33426           example: __SUBNET-ID__
33427         - name: host-route-id
33428           in: path
33429           description: host-route id
33430           required: true
33431           type: string
33432           example: __HOST-ROUTE-ID__
33433         - name: resource-version
33434           in: query
33435           description: resource-version for concurrency
33436           required: true
33437           type: string
33438   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
33439     get:
33440       tags:
33441         - Network
33442       summary: returns host-routes
33443       description: returns host-routes
33444       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
33445       produces:
33446         - application/json
33447         - application/xml
33448       responses:
33449         "200":
33450           description: successful operation
33451           schema:
33452               $ref: "#/getDefinitions/host-routes"
33453         "default":
33454           description: Response codes found in [response codes](https://wiki.onap.org/).
33455       parameters:
33456         - name: network-id
33457           in: path
33458           description: Network ID, should be uuid. Unique across A&AI.
33459           required: true
33460           type: string
33461           example: __NETWORK-ID__
33462         - name: subnet-id
33463           in: path
33464           description: Subnet ID, should be UUID.
33465           required: true
33466           type: string
33467           example: __SUBNET-ID__
33468         - name: network-name
33469           in: query
33470           description: Name of the network, governed by some naming convention..
33471           required: false
33472           type: string
33473         - name: network-role
33474           in: query
33475           description: Role the network plans - who defines these values?
33476           required: false
33477           type: string
33478         - name: service-id
33479           in: query
33480           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33481           required: false
33482           type: string
33483         - name: heat-stack-id
33484           in: query
33485           description: Heat stack id corresponding to this instance, managed by MSO
33486           required: false
33487           type: string
33488         - name: contrail-network-fqdn
33489           in: query
33490           description: Contrail FQDN for the network
33491           required: false
33492           type: string
33493         - name: model-invariant-id
33494           in: query
33495           description: the ASDC model id for this resource or service model.
33496           required: false
33497           type: string
33498         - name: model-version-id
33499           in: query
33500           description: the ASDC model version for this resource or service model.
33501           required: false
33502           type: string
33503         - name: widget-model-id
33504           in: query
33505           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33506           required: false
33507           type: string
33508         - name: widget-model-version
33509           in: query
33510           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33511           required: false
33512           type: string
33513         - name: subnet-name
33514           in: query
33515           description: Name associated with the subnet.
33516           required: false
33517           type: string
33518   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
33519     put:
33520       tags:
33521         - Network
33522       summary: see node definition for valid relationships
33523       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
33524       consumes:
33525         - application/json
33526         - application/xml
33527       produces:
33528         - application/json
33529         - application/xml
33530       responses:
33531         "default":
33532           description: Response codes found in [response codes](https://wiki.onap.org/).
33533       parameters:
33534         - name: network-id
33535           in: path
33536           description: Network ID, should be uuid. Unique across A&AI.
33537           required: true
33538           type: string
33539           example: __NETWORK-ID__
33540         - name: subnet-id
33541           in: path
33542           description: Subnet ID, should be UUID.
33543           required: true
33544           type: string
33545           example: __SUBNET-ID__
33546         - name: body
33547           in: body
33548           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
33549           required: true
33550           schema:
33551             $ref: "#/definitions/relationship"
33552     delete:
33553       tags:
33554         - Network
33555       summary: delete an existing relationship
33556       description: delete an existing relationship
33557       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
33558       consumes:
33559         - application/json
33560         - application/xml
33561       produces:
33562         - application/json
33563         - application/xml
33564       responses:
33565         "default":
33566           description: Response codes found in [response codes](https://wiki.onap.org/).
33567       parameters:
33568         - name: network-id
33569           in: path
33570           description: Network ID, should be uuid. Unique across A&AI.
33571           required: true
33572           type: string
33573           example: __NETWORK-ID__
33574         - name: subnet-id
33575           in: path
33576           description: Subnet ID, should be UUID.
33577           required: true
33578           type: string
33579           example: __SUBNET-ID__
33580   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
33581     get:
33582       tags:
33583         - Network
33584       summary: returns subnet
33585       description: returns subnet
33586       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
33587       produces:
33588         - application/json
33589         - application/xml
33590       responses:
33591         "200":
33592           description: successful operation
33593           schema:
33594               $ref: "#/getDefinitions/subnet"
33595         "default":
33596           description: Response codes found in [response codes](https://wiki.onap.org/).
33597       parameters:
33598         - name: network-id
33599           in: path
33600           description: Network ID, should be uuid. Unique across A&AI.
33601           required: true
33602           type: string
33603           example: __NETWORK-ID__
33604         - name: subnet-id
33605           in: path
33606           description: Subnet ID, should be UUID.
33607           required: true
33608           type: string
33609           example: __SUBNET-ID__
33610         - name: network-name
33611           in: query
33612           description: Name of the network, governed by some naming convention..
33613           required: false
33614           type: string
33615         - name: network-role
33616           in: query
33617           description: Role the network plans - who defines these values?
33618           required: false
33619           type: string
33620         - name: service-id
33621           in: query
33622           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33623           required: false
33624           type: string
33625         - name: heat-stack-id
33626           in: query
33627           description: Heat stack id corresponding to this instance, managed by MSO
33628           required: false
33629           type: string
33630         - name: contrail-network-fqdn
33631           in: query
33632           description: Contrail FQDN for the network
33633           required: false
33634           type: string
33635         - name: model-invariant-id
33636           in: query
33637           description: the ASDC model id for this resource or service model.
33638           required: false
33639           type: string
33640         - name: model-version-id
33641           in: query
33642           description: the ASDC model version for this resource or service model.
33643           required: false
33644           type: string
33645         - name: widget-model-id
33646           in: query
33647           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33648           required: false
33649           type: string
33650         - name: widget-model-version
33651           in: query
33652           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33653           required: false
33654           type: string
33655         - name: subnet-name
33656           in: query
33657           description: Name associated with the subnet.
33658           required: false
33659           type: string
33660     put:
33661       tags:
33662         - Network
33663       summary: create or update an existing subnet
33664       description: |
33665         Create or update an existing subnet.
33666         #
33667         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
33668       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
33669       consumes:
33670         - application/json
33671         - application/xml
33672       produces:
33673         - application/json
33674         - application/xml
33675       responses:
33676         "default":
33677           description: Response codes found in [response codes](https://wiki.onap.org/).
33678       parameters:
33679         - name: network-id
33680           in: path
33681           description: Network ID, should be uuid. Unique across A&AI.
33682           required: true
33683           type: string
33684           example: __NETWORK-ID__
33685         - name: subnet-id
33686           in: path
33687           description: Subnet ID, should be UUID.
33688           required: true
33689           type: string
33690           example: __SUBNET-ID__
33691         - name: body
33692           in: body
33693           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
33694           required: true
33695           schema:
33696             $ref: "#/definitions/subnet"
33697     patch:
33698       tags:
33699         - Network
33700       summary: update an existing subnet
33701       description: |
33702         Update an existing subnet
33703         #
33704         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33705         The PUT operation will entirely replace an existing object.
33706         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.
33707         #
33708         Other differences between PUT and PATCH are:
33709         #
33710         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33711         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33712         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33713       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
33714       consumes:
33715         - application/json
33716         - application/xml
33717       produces:
33718         - application/json
33719         - application/xml
33720       responses:
33721         "default":
33722           description: Response codes found in [response codes](https://wiki.onap.org/).
33723       parameters:
33724         - name: network-id
33725           in: path
33726           description: Network ID, should be uuid. Unique across A&AI.
33727           required: true
33728           type: string
33729           example: __NETWORK-ID__
33730         - name: subnet-id
33731           in: path
33732           description: Subnet ID, should be UUID.
33733           required: true
33734           type: string
33735           example: __SUBNET-ID__
33736         - name: body
33737           in: body
33738           description: subnet object that needs to be created or updated.
33739           required: true
33740           schema:
33741             $ref: "#/patchDefinitions/subnet"
33742     delete:
33743       tags:
33744         - Network
33745       summary: delete an existing subnet
33746       description: delete an existing subnet
33747       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
33748       consumes:
33749         - application/json
33750         - application/xml
33751       produces:
33752         - application/json
33753         - application/xml
33754       responses:
33755         "default":
33756           description: Response codes found in [response codes](https://wiki.onap.org/).
33757       parameters:
33758         - name: network-id
33759           in: path
33760           description: Network ID, should be uuid. Unique across A&AI.
33761           required: true
33762           type: string
33763           example: __NETWORK-ID__
33764         - name: subnet-id
33765           in: path
33766           description: Subnet ID, should be UUID.
33767           required: true
33768           type: string
33769           example: __SUBNET-ID__
33770         - name: resource-version
33771           in: query
33772           description: resource-version for concurrency
33773           required: true
33774           type: string
33775   /network/l3-networks/l3-network/{network-id}/subnets:
33776     get:
33777       tags:
33778         - Network
33779       summary: returns subnets
33780       description: returns subnets
33781       operationId: getNetworkL3NetworksL3NetworkSubnets
33782       produces:
33783         - application/json
33784         - application/xml
33785       responses:
33786         "200":
33787           description: successful operation
33788           schema:
33789               $ref: "#/getDefinitions/subnets"
33790         "default":
33791           description: Response codes found in [response codes](https://wiki.onap.org/).
33792       parameters:
33793         - name: network-id
33794           in: path
33795           description: Network ID, should be uuid. Unique across A&AI.
33796           required: true
33797           type: string
33798           example: __NETWORK-ID__
33799         - name: network-name
33800           in: query
33801           description: Name of the network, governed by some naming convention..
33802           required: false
33803           type: string
33804         - name: network-role
33805           in: query
33806           description: Role the network plans - who defines these values?
33807           required: false
33808           type: string
33809         - name: service-id
33810           in: query
33811           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33812           required: false
33813           type: string
33814         - name: heat-stack-id
33815           in: query
33816           description: Heat stack id corresponding to this instance, managed by MSO
33817           required: false
33818           type: string
33819         - name: contrail-network-fqdn
33820           in: query
33821           description: Contrail FQDN for the network
33822           required: false
33823           type: string
33824         - name: model-invariant-id
33825           in: query
33826           description: the ASDC model id for this resource or service model.
33827           required: false
33828           type: string
33829         - name: model-version-id
33830           in: query
33831           description: the ASDC model version for this resource or service model.
33832           required: false
33833           type: string
33834         - name: widget-model-id
33835           in: query
33836           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33837           required: false
33838           type: string
33839         - name: widget-model-version
33840           in: query
33841           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33842           required: false
33843           type: string
33844   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
33845     put:
33846       tags:
33847         - Network
33848       summary: see node definition for valid relationships
33849       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
33850       consumes:
33851         - application/json
33852         - application/xml
33853       produces:
33854         - application/json
33855         - application/xml
33856       responses:
33857         "default":
33858           description: Response codes found in [response codes](https://wiki.onap.org/).
33859       parameters:
33860         - name: network-id
33861           in: path
33862           description: Network ID, should be uuid. Unique across A&AI.
33863           required: true
33864           type: string
33865           example: __NETWORK-ID__
33866         - name: vlan-id-inner
33867           in: path
33868           description: id.
33869           required: true
33870           type: integer
33871           format: int64
33872           example: __VLAN-ID-INNER__
33873         - name: body
33874           in: body
33875           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
33876           required: true
33877           schema:
33878             $ref: "#/definitions/relationship"
33879     delete:
33880       tags:
33881         - Network
33882       summary: delete an existing relationship
33883       description: delete an existing relationship
33884       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
33885       consumes:
33886         - application/json
33887         - application/xml
33888       produces:
33889         - application/json
33890         - application/xml
33891       responses:
33892         "default":
33893           description: Response codes found in [response codes](https://wiki.onap.org/).
33894       parameters:
33895         - name: network-id
33896           in: path
33897           description: Network ID, should be uuid. Unique across A&AI.
33898           required: true
33899           type: string
33900           example: __NETWORK-ID__
33901         - name: vlan-id-inner
33902           in: path
33903           description: id.
33904           required: true
33905           type: integer
33906           format: int64
33907           example: __VLAN-ID-INNER__
33908   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
33909     get:
33910       tags:
33911         - Network
33912       summary: returns ctag-assignment
33913       description: returns ctag-assignment
33914       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33915       produces:
33916         - application/json
33917         - application/xml
33918       responses:
33919         "200":
33920           description: successful operation
33921           schema:
33922               $ref: "#/getDefinitions/ctag-assignment"
33923         "default":
33924           description: Response codes found in [response codes](https://wiki.onap.org/).
33925       parameters:
33926         - name: network-id
33927           in: path
33928           description: Network ID, should be uuid. Unique across A&AI.
33929           required: true
33930           type: string
33931           example: __NETWORK-ID__
33932         - name: vlan-id-inner
33933           in: path
33934           description: id.
33935           required: true
33936           type: integer
33937           format: int64
33938           example: __VLAN-ID-INNER__
33939         - name: network-name
33940           in: query
33941           description: Name of the network, governed by some naming convention..
33942           required: false
33943           type: string
33944         - name: network-role
33945           in: query
33946           description: Role the network plans - who defines these values?
33947           required: false
33948           type: string
33949         - name: service-id
33950           in: query
33951           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33952           required: false
33953           type: string
33954         - name: heat-stack-id
33955           in: query
33956           description: Heat stack id corresponding to this instance, managed by MSO
33957           required: false
33958           type: string
33959         - name: contrail-network-fqdn
33960           in: query
33961           description: Contrail FQDN for the network
33962           required: false
33963           type: string
33964         - name: model-invariant-id
33965           in: query
33966           description: the ASDC model id for this resource or service model.
33967           required: false
33968           type: string
33969         - name: model-version-id
33970           in: query
33971           description: the ASDC model version for this resource or service model.
33972           required: false
33973           type: string
33974         - name: widget-model-id
33975           in: query
33976           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33977           required: false
33978           type: string
33979         - name: widget-model-version
33980           in: query
33981           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33982           required: false
33983           type: string
33984     put:
33985       tags:
33986         - Network
33987       summary: create or update an existing ctag-assignment
33988       description: |
33989         Create or update an existing ctag-assignment.
33990         #
33991         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
33992       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33993       consumes:
33994         - application/json
33995         - application/xml
33996       produces:
33997         - application/json
33998         - application/xml
33999       responses:
34000         "default":
34001           description: Response codes found in [response codes](https://wiki.onap.org/).
34002       parameters:
34003         - name: network-id
34004           in: path
34005           description: Network ID, should be uuid. Unique across A&AI.
34006           required: true
34007           type: string
34008           example: __NETWORK-ID__
34009         - name: vlan-id-inner
34010           in: path
34011           description: id.
34012           required: true
34013           type: integer
34014           format: int64
34015           example: __VLAN-ID-INNER__
34016         - name: body
34017           in: body
34018           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
34019           required: true
34020           schema:
34021             $ref: "#/definitions/ctag-assignment"
34022     patch:
34023       tags:
34024         - Network
34025       summary: update an existing ctag-assignment
34026       description: |
34027         Update an existing ctag-assignment
34028         #
34029         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34030         The PUT operation will entirely replace an existing object.
34031         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.
34032         #
34033         Other differences between PUT and PATCH are:
34034         #
34035         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34036         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34037         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34038       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
34039       consumes:
34040         - application/json
34041         - application/xml
34042       produces:
34043         - application/json
34044         - application/xml
34045       responses:
34046         "default":
34047           description: Response codes found in [response codes](https://wiki.onap.org/).
34048       parameters:
34049         - name: network-id
34050           in: path
34051           description: Network ID, should be uuid. Unique across A&AI.
34052           required: true
34053           type: string
34054           example: __NETWORK-ID__
34055         - name: vlan-id-inner
34056           in: path
34057           description: id.
34058           required: true
34059           type: integer
34060           format: int64
34061           example: __VLAN-ID-INNER__
34062         - name: body
34063           in: body
34064           description: ctag-assignment object that needs to be created or updated.
34065           required: true
34066           schema:
34067             $ref: "#/patchDefinitions/ctag-assignment"
34068     delete:
34069       tags:
34070         - Network
34071       summary: delete an existing ctag-assignment
34072       description: delete an existing ctag-assignment
34073       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
34074       consumes:
34075         - application/json
34076         - application/xml
34077       produces:
34078         - application/json
34079         - application/xml
34080       responses:
34081         "default":
34082           description: Response codes found in [response codes](https://wiki.onap.org/).
34083       parameters:
34084         - name: network-id
34085           in: path
34086           description: Network ID, should be uuid. Unique across A&AI.
34087           required: true
34088           type: string
34089           example: __NETWORK-ID__
34090         - name: vlan-id-inner
34091           in: path
34092           description: id.
34093           required: true
34094           type: integer
34095           format: int64
34096           example: __VLAN-ID-INNER__
34097         - name: resource-version
34098           in: query
34099           description: resource-version for concurrency
34100           required: true
34101           type: string
34102   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
34103     get:
34104       tags:
34105         - Network
34106       summary: returns ctag-assignments
34107       description: returns ctag-assignments
34108       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
34109       produces:
34110         - application/json
34111         - application/xml
34112       responses:
34113         "200":
34114           description: successful operation
34115           schema:
34116               $ref: "#/getDefinitions/ctag-assignments"
34117         "default":
34118           description: Response codes found in [response codes](https://wiki.onap.org/).
34119       parameters:
34120         - name: network-id
34121           in: path
34122           description: Network ID, should be uuid. Unique across A&AI.
34123           required: true
34124           type: string
34125           example: __NETWORK-ID__
34126         - name: network-name
34127           in: query
34128           description: Name of the network, governed by some naming convention..
34129           required: false
34130           type: string
34131         - name: network-role
34132           in: query
34133           description: Role the network plans - who defines these values?
34134           required: false
34135           type: string
34136         - name: service-id
34137           in: query
34138           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34139           required: false
34140           type: string
34141         - name: heat-stack-id
34142           in: query
34143           description: Heat stack id corresponding to this instance, managed by MSO
34144           required: false
34145           type: string
34146         - name: contrail-network-fqdn
34147           in: query
34148           description: Contrail FQDN for the network
34149           required: false
34150           type: string
34151         - name: model-invariant-id
34152           in: query
34153           description: the ASDC model id for this resource or service model.
34154           required: false
34155           type: string
34156         - name: model-version-id
34157           in: query
34158           description: the ASDC model version for this resource or service model.
34159           required: false
34160           type: string
34161         - name: widget-model-id
34162           in: query
34163           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34164           required: false
34165           type: string
34166         - name: widget-model-version
34167           in: query
34168           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34169           required: false
34170           type: string
34171   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
34172     put:
34173       tags:
34174         - Network
34175       summary: see node definition for valid relationships
34176       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
34177       consumes:
34178         - application/json
34179         - application/xml
34180       produces:
34181         - application/json
34182         - application/xml
34183       responses:
34184         "default":
34185           description: Response codes found in [response codes](https://wiki.onap.org/).
34186       parameters:
34187         - name: network-id
34188           in: path
34189           description: Network ID, should be uuid. Unique across A&AI.
34190           required: true
34191           type: string
34192           example: __NETWORK-ID__
34193         - name: segmentation-id
34194           in: path
34195           description: Route Table Reference id, UUID assigned to this instance.
34196           required: true
34197           type: string
34198           example: __SEGMENTATION-ID__
34199         - name: body
34200           in: body
34201           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
34202           required: true
34203           schema:
34204             $ref: "#/definitions/relationship"
34205     delete:
34206       tags:
34207         - Network
34208       summary: delete an existing relationship
34209       description: delete an existing relationship
34210       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
34211       consumes:
34212         - application/json
34213         - application/xml
34214       produces:
34215         - application/json
34216         - application/xml
34217       responses:
34218         "default":
34219           description: Response codes found in [response codes](https://wiki.onap.org/).
34220       parameters:
34221         - name: network-id
34222           in: path
34223           description: Network ID, should be uuid. Unique across A&AI.
34224           required: true
34225           type: string
34226           example: __NETWORK-ID__
34227         - name: segmentation-id
34228           in: path
34229           description: Route Table Reference id, UUID assigned to this instance.
34230           required: true
34231           type: string
34232           example: __SEGMENTATION-ID__
34233   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
34234     get:
34235       tags:
34236         - Network
34237       summary: returns segmentation-assignment
34238       description: returns segmentation-assignment
34239       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34240       produces:
34241         - application/json
34242         - application/xml
34243       responses:
34244         "200":
34245           description: successful operation
34246           schema:
34247               $ref: "#/getDefinitions/segmentation-assignment"
34248         "default":
34249           description: Response codes found in [response codes](https://wiki.onap.org/).
34250       parameters:
34251         - name: network-id
34252           in: path
34253           description: Network ID, should be uuid. Unique across A&AI.
34254           required: true
34255           type: string
34256           example: __NETWORK-ID__
34257         - name: segmentation-id
34258           in: path
34259           description: Route Table Reference id, UUID assigned to this instance.
34260           required: true
34261           type: string
34262           example: __SEGMENTATION-ID__
34263         - name: network-name
34264           in: query
34265           description: Name of the network, governed by some naming convention..
34266           required: false
34267           type: string
34268         - name: network-role
34269           in: query
34270           description: Role the network plans - who defines these values?
34271           required: false
34272           type: string
34273         - name: service-id
34274           in: query
34275           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34276           required: false
34277           type: string
34278         - name: heat-stack-id
34279           in: query
34280           description: Heat stack id corresponding to this instance, managed by MSO
34281           required: false
34282           type: string
34283         - name: contrail-network-fqdn
34284           in: query
34285           description: Contrail FQDN for the network
34286           required: false
34287           type: string
34288         - name: model-invariant-id
34289           in: query
34290           description: the ASDC model id for this resource or service model.
34291           required: false
34292           type: string
34293         - name: model-version-id
34294           in: query
34295           description: the ASDC model version for this resource or service model.
34296           required: false
34297           type: string
34298         - name: widget-model-id
34299           in: query
34300           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34301           required: false
34302           type: string
34303         - name: widget-model-version
34304           in: query
34305           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34306           required: false
34307           type: string
34308     put:
34309       tags:
34310         - Network
34311       summary: create or update an existing segmentation-assignment
34312       description: |
34313         Create or update an existing segmentation-assignment.
34314         #
34315         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
34316       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34317       consumes:
34318         - application/json
34319         - application/xml
34320       produces:
34321         - application/json
34322         - application/xml
34323       responses:
34324         "default":
34325           description: Response codes found in [response codes](https://wiki.onap.org/).
34326       parameters:
34327         - name: network-id
34328           in: path
34329           description: Network ID, should be uuid. Unique across A&AI.
34330           required: true
34331           type: string
34332           example: __NETWORK-ID__
34333         - name: segmentation-id
34334           in: path
34335           description: Route Table Reference id, UUID assigned to this instance.
34336           required: true
34337           type: string
34338           example: __SEGMENTATION-ID__
34339         - name: body
34340           in: body
34341           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
34342           required: true
34343           schema:
34344             $ref: "#/definitions/segmentation-assignment"
34345     patch:
34346       tags:
34347         - Network
34348       summary: update an existing segmentation-assignment
34349       description: |
34350         Update an existing segmentation-assignment
34351         #
34352         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34353         The PUT operation will entirely replace an existing object.
34354         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.
34355         #
34356         Other differences between PUT and PATCH are:
34357         #
34358         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34359         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34360         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34361       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34362       consumes:
34363         - application/json
34364         - application/xml
34365       produces:
34366         - application/json
34367         - application/xml
34368       responses:
34369         "default":
34370           description: Response codes found in [response codes](https://wiki.onap.org/).
34371       parameters:
34372         - name: network-id
34373           in: path
34374           description: Network ID, should be uuid. Unique across A&AI.
34375           required: true
34376           type: string
34377           example: __NETWORK-ID__
34378         - name: segmentation-id
34379           in: path
34380           description: Route Table Reference id, UUID assigned to this instance.
34381           required: true
34382           type: string
34383           example: __SEGMENTATION-ID__
34384         - name: body
34385           in: body
34386           description: segmentation-assignment object that needs to be created or updated.
34387           required: true
34388           schema:
34389             $ref: "#/patchDefinitions/segmentation-assignment"
34390     delete:
34391       tags:
34392         - Network
34393       summary: delete an existing segmentation-assignment
34394       description: delete an existing segmentation-assignment
34395       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
34396       consumes:
34397         - application/json
34398         - application/xml
34399       produces:
34400         - application/json
34401         - application/xml
34402       responses:
34403         "default":
34404           description: Response codes found in [response codes](https://wiki.onap.org/).
34405       parameters:
34406         - name: network-id
34407           in: path
34408           description: Network ID, should be uuid. Unique across A&AI.
34409           required: true
34410           type: string
34411           example: __NETWORK-ID__
34412         - name: segmentation-id
34413           in: path
34414           description: Route Table Reference id, UUID assigned to this instance.
34415           required: true
34416           type: string
34417           example: __SEGMENTATION-ID__
34418         - name: resource-version
34419           in: query
34420           description: resource-version for concurrency
34421           required: true
34422           type: string
34423   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
34424     get:
34425       tags:
34426         - Network
34427       summary: returns segmentation-assignments
34428       description: returns segmentation-assignments
34429       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
34430       produces:
34431         - application/json
34432         - application/xml
34433       responses:
34434         "200":
34435           description: successful operation
34436           schema:
34437               $ref: "#/getDefinitions/segmentation-assignments"
34438         "default":
34439           description: Response codes found in [response codes](https://wiki.onap.org/).
34440       parameters:
34441         - name: network-id
34442           in: path
34443           description: Network ID, should be uuid. Unique across A&AI.
34444           required: true
34445           type: string
34446           example: __NETWORK-ID__
34447         - name: network-name
34448           in: query
34449           description: Name of the network, governed by some naming convention..
34450           required: false
34451           type: string
34452         - name: network-role
34453           in: query
34454           description: Role the network plans - who defines these values?
34455           required: false
34456           type: string
34457         - name: service-id
34458           in: query
34459           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34460           required: false
34461           type: string
34462         - name: heat-stack-id
34463           in: query
34464           description: Heat stack id corresponding to this instance, managed by MSO
34465           required: false
34466           type: string
34467         - name: contrail-network-fqdn
34468           in: query
34469           description: Contrail FQDN for the network
34470           required: false
34471           type: string
34472         - name: model-invariant-id
34473           in: query
34474           description: the ASDC model id for this resource or service model.
34475           required: false
34476           type: string
34477         - name: model-version-id
34478           in: query
34479           description: the ASDC model version for this resource or service model.
34480           required: false
34481           type: string
34482         - name: widget-model-id
34483           in: query
34484           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34485           required: false
34486           type: string
34487         - name: widget-model-version
34488           in: query
34489           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34490           required: false
34491           type: string
34492   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
34493     put:
34494       tags:
34495         - Network
34496       summary: see node definition for valid relationships
34497       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
34498       consumes:
34499         - application/json
34500         - application/xml
34501       produces:
34502         - application/json
34503         - application/xml
34504       responses:
34505         "default":
34506           description: Response codes found in [response codes](https://wiki.onap.org/).
34507       parameters:
34508         - name: network-id
34509           in: path
34510           description: Network ID, should be uuid. Unique across A&AI.
34511           required: true
34512           type: string
34513           example: __NETWORK-ID__
34514         - name: body
34515           in: body
34516           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
34517           required: true
34518           schema:
34519             $ref: "#/definitions/relationship"
34520     delete:
34521       tags:
34522         - Network
34523       summary: delete an existing relationship
34524       description: delete an existing relationship
34525       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
34526       consumes:
34527         - application/json
34528         - application/xml
34529       produces:
34530         - application/json
34531         - application/xml
34532       responses:
34533         "default":
34534           description: Response codes found in [response codes](https://wiki.onap.org/).
34535       parameters:
34536         - name: network-id
34537           in: path
34538           description: Network ID, should be uuid. Unique across A&AI.
34539           required: true
34540           type: string
34541           example: __NETWORK-ID__
34542   /network/l3-networks/l3-network/{network-id}:
34543     get:
34544       tags:
34545         - Network
34546       summary: returns l3-network
34547       description: returns l3-network
34548       operationId: getNetworkL3NetworksL3Network
34549       produces:
34550         - application/json
34551         - application/xml
34552       responses:
34553         "200":
34554           description: successful operation
34555           schema:
34556               $ref: "#/getDefinitions/l3-network"
34557         "default":
34558           description: Response codes found in [response codes](https://wiki.onap.org/).
34559       parameters:
34560         - name: network-id
34561           in: path
34562           description: Network ID, should be uuid. Unique across A&AI.
34563           required: true
34564           type: string
34565           example: __NETWORK-ID__
34566         - name: network-name
34567           in: query
34568           description: Name of the network, governed by some naming convention..
34569           required: false
34570           type: string
34571         - name: network-role
34572           in: query
34573           description: Role the network plans - who defines these values?
34574           required: false
34575           type: string
34576         - name: service-id
34577           in: query
34578           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
34579           required: false
34580           type: string
34581         - name: heat-stack-id
34582           in: query
34583           description: Heat stack id corresponding to this instance, managed by MSO
34584           required: false
34585           type: string
34586         - name: contrail-network-fqdn
34587           in: query
34588           description: Contrail FQDN for the network
34589           required: false
34590           type: string
34591         - name: model-invariant-id
34592           in: query
34593           description: the ASDC model id for this resource or service model.
34594           required: false
34595           type: string
34596         - name: model-version-id
34597           in: query
34598           description: the ASDC model version for this resource or service model.
34599           required: false
34600           type: string
34601         - name: widget-model-id
34602           in: query
34603           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34604           required: false
34605           type: string
34606         - name: widget-model-version
34607           in: query
34608           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34609           required: false
34610           type: string
34611     put:
34612       tags:
34613         - Network
34614       summary: create or update an existing l3-network
34615       description: |
34616         Create or update an existing l3-network.
34617         #
34618         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
34619       operationId: createOrUpdateNetworkL3NetworksL3Network
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: network-id
34631           in: path
34632           description: Network ID, should be uuid. Unique across A&AI.
34633           required: true
34634           type: string
34635           example: __NETWORK-ID__
34636         - name: body
34637           in: body
34638           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
34639           required: true
34640           schema:
34641             $ref: "#/definitions/l3-network"
34642     patch:
34643       tags:
34644         - Network
34645       summary: update an existing l3-network
34646       description: |
34647         Update an existing l3-network
34648         #
34649         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34650         The PUT operation will entirely replace an existing object.
34651         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.
34652         #
34653         Other differences between PUT and PATCH are:
34654         #
34655         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34656         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34657         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34658       operationId: UpdateNetworkL3NetworksL3Network
34659       consumes:
34660         - application/json
34661         - application/xml
34662       produces:
34663         - application/json
34664         - application/xml
34665       responses:
34666         "default":
34667           description: Response codes found in [response codes](https://wiki.onap.org/).
34668       parameters:
34669         - name: network-id
34670           in: path
34671           description: Network ID, should be uuid. Unique across A&AI.
34672           required: true
34673           type: string
34674           example: __NETWORK-ID__
34675         - name: body
34676           in: body
34677           description: l3-network object that needs to be created or updated.
34678           required: true
34679           schema:
34680             $ref: "#/patchDefinitions/l3-network"
34681     delete:
34682       tags:
34683         - Network
34684       summary: delete an existing l3-network
34685       description: delete an existing l3-network
34686       operationId: deleteNetworkL3NetworksL3Network
34687       consumes:
34688         - application/json
34689         - application/xml
34690       produces:
34691         - application/json
34692         - application/xml
34693       responses:
34694         "default":
34695           description: Response codes found in [response codes](https://wiki.onap.org/).
34696       parameters:
34697         - name: network-id
34698           in: path
34699           description: Network ID, should be uuid. Unique across A&AI.
34700           required: true
34701           type: string
34702           example: __NETWORK-ID__
34703         - name: resource-version
34704           in: query
34705           description: resource-version for concurrency
34706           required: true
34707           type: string
34708   /network/l3-networks:
34709     get:
34710       tags:
34711         - Network
34712       summary: returns l3-networks
34713       description: returns l3-networks
34714       operationId: getNetworkL3Networks
34715       produces:
34716         - application/json
34717         - application/xml
34718       responses:
34719         "200":
34720           description: successful operation
34721           schema:
34722               $ref: "#/getDefinitions/l3-networks"
34723         "default":
34724           description: Response codes found in [response codes](https://wiki.onap.org/).
34725   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
34726     put:
34727       tags:
34728         - Network
34729       summary: see node definition for valid relationships
34730       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
34731       consumes:
34732         - application/json
34733         - application/xml
34734       produces:
34735         - application/json
34736         - application/xml
34737       responses:
34738         "default":
34739           description: Response codes found in [response codes](https://wiki.onap.org/).
34740       parameters:
34741         - name: network-policy-id
34742           in: path
34743           description: UUID representing unique key to this instance
34744           required: true
34745           type: string
34746           example: __NETWORK-POLICY-ID__
34747         - name: body
34748           in: body
34749           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
34750           required: true
34751           schema:
34752             $ref: "#/definitions/relationship"
34753     delete:
34754       tags:
34755         - Network
34756       summary: delete an existing relationship
34757       description: delete an existing relationship
34758       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
34759       consumes:
34760         - application/json
34761         - application/xml
34762       produces:
34763         - application/json
34764         - application/xml
34765       responses:
34766         "default":
34767           description: Response codes found in [response codes](https://wiki.onap.org/).
34768       parameters:
34769         - name: network-policy-id
34770           in: path
34771           description: UUID representing unique key to this instance
34772           required: true
34773           type: string
34774           example: __NETWORK-POLICY-ID__
34775   /network/network-policies/network-policy/{network-policy-id}:
34776     get:
34777       tags:
34778         - Network
34779       summary: returns network-policy
34780       description: returns network-policy
34781       operationId: getNetworkNetworkPoliciesNetworkPolicy
34782       produces:
34783         - application/json
34784         - application/xml
34785       responses:
34786         "200":
34787           description: successful operation
34788           schema:
34789               $ref: "#/getDefinitions/network-policy"
34790         "default":
34791           description: Response codes found in [response codes](https://wiki.onap.org/).
34792       parameters:
34793         - name: network-policy-id
34794           in: path
34795           description: UUID representing unique key to this instance
34796           required: true
34797           type: string
34798           example: __NETWORK-POLICY-ID__
34799         - name: network-policy-fqdn
34800           in: query
34801           description: Contrail FQDN for the policy
34802           required: false
34803           type: string
34804     put:
34805       tags:
34806         - Network
34807       summary: create or update an existing network-policy
34808       description: |
34809         Create or update an existing network-policy.
34810         #
34811         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
34812       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
34813       consumes:
34814         - application/json
34815         - application/xml
34816       produces:
34817         - application/json
34818         - application/xml
34819       responses:
34820         "default":
34821           description: Response codes found in [response codes](https://wiki.onap.org/).
34822       parameters:
34823         - name: network-policy-id
34824           in: path
34825           description: UUID representing unique key to this instance
34826           required: true
34827           type: string
34828           example: __NETWORK-POLICY-ID__
34829         - name: body
34830           in: body
34831           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
34832           required: true
34833           schema:
34834             $ref: "#/definitions/network-policy"
34835     patch:
34836       tags:
34837         - Network
34838       summary: update an existing network-policy
34839       description: |
34840         Update an existing network-policy
34841         #
34842         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34843         The PUT operation will entirely replace an existing object.
34844         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.
34845         #
34846         Other differences between PUT and PATCH are:
34847         #
34848         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34849         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34850         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34851       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
34852       consumes:
34853         - application/json
34854         - application/xml
34855       produces:
34856         - application/json
34857         - application/xml
34858       responses:
34859         "default":
34860           description: Response codes found in [response codes](https://wiki.onap.org/).
34861       parameters:
34862         - name: network-policy-id
34863           in: path
34864           description: UUID representing unique key to this instance
34865           required: true
34866           type: string
34867           example: __NETWORK-POLICY-ID__
34868         - name: body
34869           in: body
34870           description: network-policy object that needs to be created or updated.
34871           required: true
34872           schema:
34873             $ref: "#/patchDefinitions/network-policy"
34874     delete:
34875       tags:
34876         - Network
34877       summary: delete an existing network-policy
34878       description: delete an existing network-policy
34879       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
34880       consumes:
34881         - application/json
34882         - application/xml
34883       produces:
34884         - application/json
34885         - application/xml
34886       responses:
34887         "default":
34888           description: Response codes found in [response codes](https://wiki.onap.org/).
34889       parameters:
34890         - name: network-policy-id
34891           in: path
34892           description: UUID representing unique key to this instance
34893           required: true
34894           type: string
34895           example: __NETWORK-POLICY-ID__
34896         - name: resource-version
34897           in: query
34898           description: resource-version for concurrency
34899           required: true
34900           type: string
34901   /network/network-policies:
34902     get:
34903       tags:
34904         - Network
34905       summary: returns network-policies
34906       description: returns network-policies
34907       operationId: getNetworkNetworkPolicies
34908       produces:
34909         - application/json
34910         - application/xml
34911       responses:
34912         "200":
34913           description: successful operation
34914           schema:
34915               $ref: "#/getDefinitions/network-policies"
34916         "default":
34917           description: Response codes found in [response codes](https://wiki.onap.org/).
34918   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
34919     put:
34920       tags:
34921         - Network
34922       summary: see node definition for valid relationships
34923       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
34924       consumes:
34925         - application/json
34926         - application/xml
34927       produces:
34928         - application/json
34929         - application/xml
34930       responses:
34931         "default":
34932           description: Response codes found in [response codes](https://wiki.onap.org/).
34933       parameters:
34934         - name: vnf-id
34935           in: path
34936           description: Unique id of VNF.  This is unique across the graph.
34937           required: true
34938           type: string
34939           example: __VNF-ID__
34940         - name: body
34941           in: body
34942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
34943           required: true
34944           schema:
34945             $ref: "#/definitions/relationship"
34946     delete:
34947       tags:
34948         - Network
34949       summary: delete an existing relationship
34950       description: delete an existing relationship
34951       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
34952       consumes:
34953         - application/json
34954         - application/xml
34955       produces:
34956         - application/json
34957         - application/xml
34958       responses:
34959         "default":
34960           description: Response codes found in [response codes](https://wiki.onap.org/).
34961       parameters:
34962         - name: vnf-id
34963           in: path
34964           description: Unique id of VNF.  This is unique across the graph.
34965           required: true
34966           type: string
34967           example: __VNF-ID__
34968   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34969     put:
34970       tags:
34971         - Network
34972       summary: see node definition for valid relationships
34973       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34974       consumes:
34975         - application/json
34976         - application/xml
34977       produces:
34978         - application/json
34979         - application/xml
34980       responses:
34981         "default":
34982           description: Response codes found in [response codes](https://wiki.onap.org/).
34983       parameters:
34984         - name: vnf-id
34985           in: path
34986           description: Unique id of VNF.  This is unique across the graph.
34987           required: true
34988           type: string
34989           example: __VNF-ID__
34990         - name: interface-name
34991           in: path
34992           description: Name given to the interface
34993           required: true
34994           type: string
34995           example: __INTERFACE-NAME__
34996         - name: vlan-interface
34997           in: path
34998           description: String that identifies the interface
34999           required: true
35000           type: string
35001           example: __VLAN-INTERFACE__
35002         - name: body
35003           in: body
35004           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
35005           required: true
35006           schema:
35007             $ref: "#/definitions/relationship"
35008     delete:
35009       tags:
35010         - Network
35011       summary: delete an existing relationship
35012       description: delete an existing relationship
35013       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
35014       consumes:
35015         - application/json
35016         - application/xml
35017       produces:
35018         - application/json
35019         - application/xml
35020       responses:
35021         "default":
35022           description: Response codes found in [response codes](https://wiki.onap.org/).
35023       parameters:
35024         - name: vnf-id
35025           in: path
35026           description: Unique id of VNF.  This is unique across the graph.
35027           required: true
35028           type: string
35029           example: __VNF-ID__
35030         - name: interface-name
35031           in: path
35032           description: Name given to the interface
35033           required: true
35034           type: string
35035           example: __INTERFACE-NAME__
35036         - name: vlan-interface
35037           in: path
35038           description: String that identifies the interface
35039           required: true
35040           type: string
35041           example: __VLAN-INTERFACE__
35042   /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:
35043     put:
35044       tags:
35045         - Network
35046       summary: see node definition for valid relationships
35047       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35048       consumes:
35049         - application/json
35050         - application/xml
35051       produces:
35052         - application/json
35053         - application/xml
35054       responses:
35055         "default":
35056           description: Response codes found in [response codes](https://wiki.onap.org/).
35057       parameters:
35058         - name: vnf-id
35059           in: path
35060           description: Unique id of VNF.  This is unique across the graph.
35061           required: true
35062           type: string
35063           example: __VNF-ID__
35064         - name: interface-name
35065           in: path
35066           description: Name given to the interface
35067           required: true
35068           type: string
35069           example: __INTERFACE-NAME__
35070         - name: vlan-interface
35071           in: path
35072           description: String that identifies the interface
35073           required: true
35074           type: string
35075           example: __VLAN-INTERFACE__
35076         - name: l3-interface-ipv4-address
35077           in: path
35078           description: IP address
35079           required: true
35080           type: string
35081           example: __L3-INTERFACE-IPV4-ADDRESS__
35082         - name: body
35083           in: body
35084           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35085           required: true
35086           schema:
35087             $ref: "#/definitions/relationship"
35088     delete:
35089       tags:
35090         - Network
35091       summary: delete an existing relationship
35092       description: delete an existing relationship
35093       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35094       consumes:
35095         - application/json
35096         - application/xml
35097       produces:
35098         - application/json
35099         - application/xml
35100       responses:
35101         "default":
35102           description: Response codes found in [response codes](https://wiki.onap.org/).
35103       parameters:
35104         - name: vnf-id
35105           in: path
35106           description: Unique id of VNF.  This is unique across the graph.
35107           required: true
35108           type: string
35109           example: __VNF-ID__
35110         - name: interface-name
35111           in: path
35112           description: Name given to the interface
35113           required: true
35114           type: string
35115           example: __INTERFACE-NAME__
35116         - name: vlan-interface
35117           in: path
35118           description: String that identifies the interface
35119           required: true
35120           type: string
35121           example: __VLAN-INTERFACE__
35122         - name: l3-interface-ipv4-address
35123           in: path
35124           description: IP address
35125           required: true
35126           type: string
35127           example: __L3-INTERFACE-IPV4-ADDRESS__
35128   /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}:
35129     get:
35130       tags:
35131         - Network
35132       summary: returns l3-interface-ipv4-address-list
35133       description: returns l3-interface-ipv4-address-list
35134       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35135       produces:
35136         - application/json
35137         - application/xml
35138       responses:
35139         "200":
35140           description: successful operation
35141           schema:
35142               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35143         "default":
35144           description: Response codes found in [response codes](https://wiki.onap.org/).
35145       parameters:
35146         - name: vnf-id
35147           in: path
35148           description: Unique id of VNF.  This is unique across the graph.
35149           required: true
35150           type: string
35151           example: __VNF-ID__
35152         - name: interface-name
35153           in: path
35154           description: Name given to the interface
35155           required: true
35156           type: string
35157           example: __INTERFACE-NAME__
35158         - name: vlan-interface
35159           in: path
35160           description: String that identifies the interface
35161           required: true
35162           type: string
35163           example: __VLAN-INTERFACE__
35164         - name: l3-interface-ipv4-address
35165           in: path
35166           description: IP address
35167           required: true
35168           type: string
35169           example: __L3-INTERFACE-IPV4-ADDRESS__
35170         - name: vnf-name
35171           in: query
35172           description: Name of VNF.
35173           required: false
35174           type: string
35175         - name: vnf-name2
35176           in: query
35177           description: Alternate name of VNF.
35178           required: false
35179           type: string
35180         - name: vnf-type
35181           in: query
35182           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.
35183           required: false
35184           type: string
35185         - name: service-id
35186           in: query
35187           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35188           required: false
35189           type: string
35190         - name: regional-resource-zone
35191           in: query
35192           description: Regional way of organizing pservers, source of truth should define values
35193           required: false
35194           type: string
35195         - name: prov-status
35196           in: query
35197           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35198           required: false
35199           type: string
35200         - name: heat-stack-id
35201           in: query
35202           description: Heat stack id corresponding to this instance, managed by MSO
35203           required: false
35204           type: string
35205         - name: in-maint
35206           in: query
35207           required: false
35208           type: boolean
35209         - name: is-closed-loop-disabled
35210           in: query
35211           required: false
35212           type: boolean
35213         - name: model-invariant-id
35214           in: query
35215           description: the ASDC model id for this resource or service model.
35216           required: false
35217           type: string
35218         - name: model-version-id
35219           in: query
35220           description: the ASDC model version for this resource or service model.
35221           required: false
35222           type: string
35223         - name: widget-model-id
35224           in: query
35225           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35226           required: false
35227           type: string
35228         - name: widget-model-version
35229           in: query
35230           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35231           required: false
35232           type: string
35233         - name: nf-type
35234           in: query
35235           description: Generic description of the type of NF
35236           required: false
35237           type: string
35238         - name: nf-function
35239           in: query
35240           description: English description of Network function that the specific VNF deployment is providing
35241           required: false
35242           type: string
35243         - name: nf-role
35244           in: query
35245           description: role in the network that this model will be providing
35246           required: false
35247           type: string
35248         - name: nf-naming-code
35249           in: query
35250           description: string assigned to this model used for naming purposes
35251           required: false
35252           type: string
35253         - name: interface-id
35254           in: query
35255           description: ID of interface
35256           required: false
35257           type: string
35258         - name: macaddr
35259           in: query
35260           description: MAC address for the interface
35261           required: false
35262           type: string
35263         - name: network-name
35264           in: query
35265           description: Name of the network
35266           required: false
35267           type: string
35268         - name: vlan-id-inner
35269           in: query
35270           description: Inner VLAN tag
35271           required: false
35272           type: integer
35273           format: int64
35274         - name: vpn-key
35275           in: query
35276           description: This indicates the customers VPN ID associated with this vlan
35277           required: false
35278           type: string
35279         - name: vlan-id-inner
35280           in: query
35281           description: Inner VLAN tag
35282           required: false
35283           type: integer
35284           format: int64
35285         - name: neutron-network-id
35286           in: query
35287           description: Neutron network id of the interface that address belongs to
35288           required: false
35289           type: string
35290         - name: neutron-subnet-id
35291           in: query
35292           description: Neutron id of subnet that address belongs to
35293           required: false
35294           type: string
35295     put:
35296       tags:
35297         - Network
35298       summary: create or update an existing l3-interface-ipv4-address-list
35299       description: |
35300         Create or update an existing l3-interface-ipv4-address-list.
35301         #
35302         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
35303       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35304       consumes:
35305         - application/json
35306         - application/xml
35307       produces:
35308         - application/json
35309         - application/xml
35310       responses:
35311         "default":
35312           description: Response codes found in [response codes](https://wiki.onap.org/).
35313       parameters:
35314         - name: vnf-id
35315           in: path
35316           description: Unique id of VNF.  This is unique across the graph.
35317           required: true
35318           type: string
35319           example: __VNF-ID__
35320         - name: interface-name
35321           in: path
35322           description: Name given to the interface
35323           required: true
35324           type: string
35325           example: __INTERFACE-NAME__
35326         - name: vlan-interface
35327           in: path
35328           description: String that identifies the interface
35329           required: true
35330           type: string
35331           example: __VLAN-INTERFACE__
35332         - name: l3-interface-ipv4-address
35333           in: path
35334           description: IP address
35335           required: true
35336           type: string
35337           example: __L3-INTERFACE-IPV4-ADDRESS__
35338         - name: body
35339           in: body
35340           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35341           required: true
35342           schema:
35343             $ref: "#/definitions/l3-interface-ipv4-address-list"
35344     patch:
35345       tags:
35346         - Network
35347       summary: update an existing l3-interface-ipv4-address-list
35348       description: |
35349         Update an existing l3-interface-ipv4-address-list
35350         #
35351         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35352         The PUT operation will entirely replace an existing object.
35353         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.
35354         #
35355         Other differences between PUT and PATCH are:
35356         #
35357         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35358         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35359         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35360       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35361       consumes:
35362         - application/json
35363         - application/xml
35364       produces:
35365         - application/json
35366         - application/xml
35367       responses:
35368         "default":
35369           description: Response codes found in [response codes](https://wiki.onap.org/).
35370       parameters:
35371         - name: vnf-id
35372           in: path
35373           description: Unique id of VNF.  This is unique across the graph.
35374           required: true
35375           type: string
35376           example: __VNF-ID__
35377         - name: interface-name
35378           in: path
35379           description: Name given to the interface
35380           required: true
35381           type: string
35382           example: __INTERFACE-NAME__
35383         - name: vlan-interface
35384           in: path
35385           description: String that identifies the interface
35386           required: true
35387           type: string
35388           example: __VLAN-INTERFACE__
35389         - name: l3-interface-ipv4-address
35390           in: path
35391           description: IP address
35392           required: true
35393           type: string
35394           example: __L3-INTERFACE-IPV4-ADDRESS__
35395         - name: body
35396           in: body
35397           description: l3-interface-ipv4-address-list object that needs to be created or updated.
35398           required: true
35399           schema:
35400             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35401     delete:
35402       tags:
35403         - Network
35404       summary: delete an existing l3-interface-ipv4-address-list
35405       description: delete an existing l3-interface-ipv4-address-list
35406       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35407       consumes:
35408         - application/json
35409         - application/xml
35410       produces:
35411         - application/json
35412         - application/xml
35413       responses:
35414         "default":
35415           description: Response codes found in [response codes](https://wiki.onap.org/).
35416       parameters:
35417         - name: vnf-id
35418           in: path
35419           description: Unique id of VNF.  This is unique across the graph.
35420           required: true
35421           type: string
35422           example: __VNF-ID__
35423         - name: interface-name
35424           in: path
35425           description: Name given to the interface
35426           required: true
35427           type: string
35428           example: __INTERFACE-NAME__
35429         - name: vlan-interface
35430           in: path
35431           description: String that identifies the interface
35432           required: true
35433           type: string
35434           example: __VLAN-INTERFACE__
35435         - name: l3-interface-ipv4-address
35436           in: path
35437           description: IP address
35438           required: true
35439           type: string
35440           example: __L3-INTERFACE-IPV4-ADDRESS__
35441         - name: resource-version
35442           in: query
35443           description: resource-version for concurrency
35444           required: true
35445           type: string
35446   /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:
35447     put:
35448       tags:
35449         - Network
35450       summary: see node definition for valid relationships
35451       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35452       consumes:
35453         - application/json
35454         - application/xml
35455       produces:
35456         - application/json
35457         - application/xml
35458       responses:
35459         "default":
35460           description: Response codes found in [response codes](https://wiki.onap.org/).
35461       parameters:
35462         - name: vnf-id
35463           in: path
35464           description: Unique id of VNF.  This is unique across the graph.
35465           required: true
35466           type: string
35467           example: __VNF-ID__
35468         - name: interface-name
35469           in: path
35470           description: Name given to the interface
35471           required: true
35472           type: string
35473           example: __INTERFACE-NAME__
35474         - name: vlan-interface
35475           in: path
35476           description: String that identifies the interface
35477           required: true
35478           type: string
35479           example: __VLAN-INTERFACE__
35480         - name: l3-interface-ipv6-address
35481           in: path
35482           description: IP address
35483           required: true
35484           type: string
35485           example: __L3-INTERFACE-IPV6-ADDRESS__
35486         - name: body
35487           in: body
35488           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35489           required: true
35490           schema:
35491             $ref: "#/definitions/relationship"
35492     delete:
35493       tags:
35494         - Network
35495       summary: delete an existing relationship
35496       description: delete an existing relationship
35497       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35498       consumes:
35499         - application/json
35500         - application/xml
35501       produces:
35502         - application/json
35503         - application/xml
35504       responses:
35505         "default":
35506           description: Response codes found in [response codes](https://wiki.onap.org/).
35507       parameters:
35508         - name: vnf-id
35509           in: path
35510           description: Unique id of VNF.  This is unique across the graph.
35511           required: true
35512           type: string
35513           example: __VNF-ID__
35514         - name: interface-name
35515           in: path
35516           description: Name given to the interface
35517           required: true
35518           type: string
35519           example: __INTERFACE-NAME__
35520         - name: vlan-interface
35521           in: path
35522           description: String that identifies the interface
35523           required: true
35524           type: string
35525           example: __VLAN-INTERFACE__
35526         - name: l3-interface-ipv6-address
35527           in: path
35528           description: IP address
35529           required: true
35530           type: string
35531           example: __L3-INTERFACE-IPV6-ADDRESS__
35532   /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}:
35533     get:
35534       tags:
35535         - Network
35536       summary: returns l3-interface-ipv6-address-list
35537       description: returns l3-interface-ipv6-address-list
35538       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35539       produces:
35540         - application/json
35541         - application/xml
35542       responses:
35543         "200":
35544           description: successful operation
35545           schema:
35546               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35547         "default":
35548           description: Response codes found in [response codes](https://wiki.onap.org/).
35549       parameters:
35550         - name: vnf-id
35551           in: path
35552           description: Unique id of VNF.  This is unique across the graph.
35553           required: true
35554           type: string
35555           example: __VNF-ID__
35556         - name: interface-name
35557           in: path
35558           description: Name given to the interface
35559           required: true
35560           type: string
35561           example: __INTERFACE-NAME__
35562         - name: vlan-interface
35563           in: path
35564           description: String that identifies the interface
35565           required: true
35566           type: string
35567           example: __VLAN-INTERFACE__
35568         - name: l3-interface-ipv6-address
35569           in: path
35570           description: IP address
35571           required: true
35572           type: string
35573           example: __L3-INTERFACE-IPV6-ADDRESS__
35574         - name: vnf-name
35575           in: query
35576           description: Name of VNF.
35577           required: false
35578           type: string
35579         - name: vnf-name2
35580           in: query
35581           description: Alternate name of VNF.
35582           required: false
35583           type: string
35584         - name: vnf-type
35585           in: query
35586           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.
35587           required: false
35588           type: string
35589         - name: service-id
35590           in: query
35591           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35592           required: false
35593           type: string
35594         - name: regional-resource-zone
35595           in: query
35596           description: Regional way of organizing pservers, source of truth should define values
35597           required: false
35598           type: string
35599         - name: prov-status
35600           in: query
35601           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35602           required: false
35603           type: string
35604         - name: heat-stack-id
35605           in: query
35606           description: Heat stack id corresponding to this instance, managed by MSO
35607           required: false
35608           type: string
35609         - name: in-maint
35610           in: query
35611           required: false
35612           type: boolean
35613         - name: is-closed-loop-disabled
35614           in: query
35615           required: false
35616           type: boolean
35617         - name: model-invariant-id
35618           in: query
35619           description: the ASDC model id for this resource or service model.
35620           required: false
35621           type: string
35622         - name: model-version-id
35623           in: query
35624           description: the ASDC model version for this resource or service model.
35625           required: false
35626           type: string
35627         - name: widget-model-id
35628           in: query
35629           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35630           required: false
35631           type: string
35632         - name: widget-model-version
35633           in: query
35634           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35635           required: false
35636           type: string
35637         - name: nf-type
35638           in: query
35639           description: Generic description of the type of NF
35640           required: false
35641           type: string
35642         - name: nf-function
35643           in: query
35644           description: English description of Network function that the specific VNF deployment is providing
35645           required: false
35646           type: string
35647         - name: nf-role
35648           in: query
35649           description: role in the network that this model will be providing
35650           required: false
35651           type: string
35652         - name: nf-naming-code
35653           in: query
35654           description: string assigned to this model used for naming purposes
35655           required: false
35656           type: string
35657         - name: interface-id
35658           in: query
35659           description: ID of interface
35660           required: false
35661           type: string
35662         - name: macaddr
35663           in: query
35664           description: MAC address for the interface
35665           required: false
35666           type: string
35667         - name: network-name
35668           in: query
35669           description: Name of the network
35670           required: false
35671           type: string
35672         - name: vlan-id-inner
35673           in: query
35674           description: Inner VLAN tag
35675           required: false
35676           type: integer
35677           format: int64
35678         - name: vpn-key
35679           in: query
35680           description: This indicates the customers VPN ID associated with this vlan
35681           required: false
35682           type: string
35683         - name: vlan-id-inner
35684           in: query
35685           description: Inner VLAN tag
35686           required: false
35687           type: integer
35688           format: int64
35689         - name: neutron-network-id
35690           in: query
35691           description: Neutron network id of the interface that address belongs to
35692           required: false
35693           type: string
35694         - name: neutron-subnet-id
35695           in: query
35696           description: Neutron id of subnet that address belongs to
35697           required: false
35698           type: string
35699     put:
35700       tags:
35701         - Network
35702       summary: create or update an existing l3-interface-ipv6-address-list
35703       description: |
35704         Create or update an existing l3-interface-ipv6-address-list.
35705         #
35706         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
35707       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35708       consumes:
35709         - application/json
35710         - application/xml
35711       produces:
35712         - application/json
35713         - application/xml
35714       responses:
35715         "default":
35716           description: Response codes found in [response codes](https://wiki.onap.org/).
35717       parameters:
35718         - name: vnf-id
35719           in: path
35720           description: Unique id of VNF.  This is unique across the graph.
35721           required: true
35722           type: string
35723           example: __VNF-ID__
35724         - name: interface-name
35725           in: path
35726           description: Name given to the interface
35727           required: true
35728           type: string
35729           example: __INTERFACE-NAME__
35730         - name: vlan-interface
35731           in: path
35732           description: String that identifies the interface
35733           required: true
35734           type: string
35735           example: __VLAN-INTERFACE__
35736         - name: l3-interface-ipv6-address
35737           in: path
35738           description: IP address
35739           required: true
35740           type: string
35741           example: __L3-INTERFACE-IPV6-ADDRESS__
35742         - name: body
35743           in: body
35744           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35745           required: true
35746           schema:
35747             $ref: "#/definitions/l3-interface-ipv6-address-list"
35748     patch:
35749       tags:
35750         - Network
35751       summary: update an existing l3-interface-ipv6-address-list
35752       description: |
35753         Update an existing l3-interface-ipv6-address-list
35754         #
35755         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35756         The PUT operation will entirely replace an existing object.
35757         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.
35758         #
35759         Other differences between PUT and PATCH are:
35760         #
35761         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35762         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35763         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35764       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35765       consumes:
35766         - application/json
35767         - application/xml
35768       produces:
35769         - application/json
35770         - application/xml
35771       responses:
35772         "default":
35773           description: Response codes found in [response codes](https://wiki.onap.org/).
35774       parameters:
35775         - name: vnf-id
35776           in: path
35777           description: Unique id of VNF.  This is unique across the graph.
35778           required: true
35779           type: string
35780           example: __VNF-ID__
35781         - name: interface-name
35782           in: path
35783           description: Name given to the interface
35784           required: true
35785           type: string
35786           example: __INTERFACE-NAME__
35787         - name: vlan-interface
35788           in: path
35789           description: String that identifies the interface
35790           required: true
35791           type: string
35792           example: __VLAN-INTERFACE__
35793         - name: l3-interface-ipv6-address
35794           in: path
35795           description: IP address
35796           required: true
35797           type: string
35798           example: __L3-INTERFACE-IPV6-ADDRESS__
35799         - name: body
35800           in: body
35801           description: l3-interface-ipv6-address-list object that needs to be created or updated.
35802           required: true
35803           schema:
35804             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35805     delete:
35806       tags:
35807         - Network
35808       summary: delete an existing l3-interface-ipv6-address-list
35809       description: delete an existing l3-interface-ipv6-address-list
35810       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35811       consumes:
35812         - application/json
35813         - application/xml
35814       produces:
35815         - application/json
35816         - application/xml
35817       responses:
35818         "default":
35819           description: Response codes found in [response codes](https://wiki.onap.org/).
35820       parameters:
35821         - name: vnf-id
35822           in: path
35823           description: Unique id of VNF.  This is unique across the graph.
35824           required: true
35825           type: string
35826           example: __VNF-ID__
35827         - name: interface-name
35828           in: path
35829           description: Name given to the interface
35830           required: true
35831           type: string
35832           example: __INTERFACE-NAME__
35833         - name: vlan-interface
35834           in: path
35835           description: String that identifies the interface
35836           required: true
35837           type: string
35838           example: __VLAN-INTERFACE__
35839         - name: l3-interface-ipv6-address
35840           in: path
35841           description: IP address
35842           required: true
35843           type: string
35844           example: __L3-INTERFACE-IPV6-ADDRESS__
35845         - name: resource-version
35846           in: query
35847           description: resource-version for concurrency
35848           required: true
35849           type: string
35850   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35851     get:
35852       tags:
35853         - Network
35854       summary: returns vlan
35855       description: returns vlan
35856       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35857       produces:
35858         - application/json
35859         - application/xml
35860       responses:
35861         "200":
35862           description: successful operation
35863           schema:
35864               $ref: "#/getDefinitions/vlan"
35865         "default":
35866           description: Response codes found in [response codes](https://wiki.onap.org/).
35867       parameters:
35868         - name: vnf-id
35869           in: path
35870           description: Unique id of VNF.  This is unique across the graph.
35871           required: true
35872           type: string
35873           example: __VNF-ID__
35874         - name: interface-name
35875           in: path
35876           description: Name given to the interface
35877           required: true
35878           type: string
35879           example: __INTERFACE-NAME__
35880         - name: vlan-interface
35881           in: path
35882           description: String that identifies the interface
35883           required: true
35884           type: string
35885           example: __VLAN-INTERFACE__
35886         - name: vnf-name
35887           in: query
35888           description: Name of VNF.
35889           required: false
35890           type: string
35891         - name: vnf-name2
35892           in: query
35893           description: Alternate name of VNF.
35894           required: false
35895           type: string
35896         - name: vnf-type
35897           in: query
35898           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.
35899           required: false
35900           type: string
35901         - name: service-id
35902           in: query
35903           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35904           required: false
35905           type: string
35906         - name: regional-resource-zone
35907           in: query
35908           description: Regional way of organizing pservers, source of truth should define values
35909           required: false
35910           type: string
35911         - name: prov-status
35912           in: query
35913           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35914           required: false
35915           type: string
35916         - name: heat-stack-id
35917           in: query
35918           description: Heat stack id corresponding to this instance, managed by MSO
35919           required: false
35920           type: string
35921         - name: in-maint
35922           in: query
35923           required: false
35924           type: boolean
35925         - name: is-closed-loop-disabled
35926           in: query
35927           required: false
35928           type: boolean
35929         - name: model-invariant-id
35930           in: query
35931           description: the ASDC model id for this resource or service model.
35932           required: false
35933           type: string
35934         - name: model-version-id
35935           in: query
35936           description: the ASDC model version for this resource or service model.
35937           required: false
35938           type: string
35939         - name: widget-model-id
35940           in: query
35941           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35942           required: false
35943           type: string
35944         - name: widget-model-version
35945           in: query
35946           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35947           required: false
35948           type: string
35949         - name: nf-type
35950           in: query
35951           description: Generic description of the type of NF
35952           required: false
35953           type: string
35954         - name: nf-function
35955           in: query
35956           description: English description of Network function that the specific VNF deployment is providing
35957           required: false
35958           type: string
35959         - name: nf-role
35960           in: query
35961           description: role in the network that this model will be providing
35962           required: false
35963           type: string
35964         - name: nf-naming-code
35965           in: query
35966           description: string assigned to this model used for naming purposes
35967           required: false
35968           type: string
35969         - name: interface-id
35970           in: query
35971           description: ID of interface
35972           required: false
35973           type: string
35974         - name: macaddr
35975           in: query
35976           description: MAC address for the interface
35977           required: false
35978           type: string
35979         - name: network-name
35980           in: query
35981           description: Name of the network
35982           required: false
35983           type: string
35984         - name: vlan-id-inner
35985           in: query
35986           description: Inner VLAN tag
35987           required: false
35988           type: integer
35989           format: int64
35990         - name: vpn-key
35991           in: query
35992           description: This indicates the customers VPN ID associated with this vlan
35993           required: false
35994           type: string
35995     put:
35996       tags:
35997         - Network
35998       summary: create or update an existing vlan
35999       description: |
36000         Create or update an existing vlan.
36001         #
36002         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
36003       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36004       consumes:
36005         - application/json
36006         - application/xml
36007       produces:
36008         - application/json
36009         - application/xml
36010       responses:
36011         "default":
36012           description: Response codes found in [response codes](https://wiki.onap.org/).
36013       parameters:
36014         - name: vnf-id
36015           in: path
36016           description: Unique id of VNF.  This is unique across the graph.
36017           required: true
36018           type: string
36019           example: __VNF-ID__
36020         - name: interface-name
36021           in: path
36022           description: Name given to the interface
36023           required: true
36024           type: string
36025           example: __INTERFACE-NAME__
36026         - name: vlan-interface
36027           in: path
36028           description: String that identifies the interface
36029           required: true
36030           type: string
36031           example: __VLAN-INTERFACE__
36032         - name: body
36033           in: body
36034           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
36035           required: true
36036           schema:
36037             $ref: "#/definitions/vlan"
36038     patch:
36039       tags:
36040         - Network
36041       summary: update an existing vlan
36042       description: |
36043         Update an existing vlan
36044         #
36045         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36046         The PUT operation will entirely replace an existing object.
36047         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.
36048         #
36049         Other differences between PUT and PATCH are:
36050         #
36051         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36052         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36053         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36054       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36055       consumes:
36056         - application/json
36057         - application/xml
36058       produces:
36059         - application/json
36060         - application/xml
36061       responses:
36062         "default":
36063           description: Response codes found in [response codes](https://wiki.onap.org/).
36064       parameters:
36065         - name: vnf-id
36066           in: path
36067           description: Unique id of VNF.  This is unique across the graph.
36068           required: true
36069           type: string
36070           example: __VNF-ID__
36071         - name: interface-name
36072           in: path
36073           description: Name given to the interface
36074           required: true
36075           type: string
36076           example: __INTERFACE-NAME__
36077         - name: vlan-interface
36078           in: path
36079           description: String that identifies the interface
36080           required: true
36081           type: string
36082           example: __VLAN-INTERFACE__
36083         - name: body
36084           in: body
36085           description: vlan object that needs to be created or updated.
36086           required: true
36087           schema:
36088             $ref: "#/patchDefinitions/vlan"
36089     delete:
36090       tags:
36091         - Network
36092       summary: delete an existing vlan
36093       description: delete an existing vlan
36094       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
36095       consumes:
36096         - application/json
36097         - application/xml
36098       produces:
36099         - application/json
36100         - application/xml
36101       responses:
36102         "default":
36103           description: Response codes found in [response codes](https://wiki.onap.org/).
36104       parameters:
36105         - name: vnf-id
36106           in: path
36107           description: Unique id of VNF.  This is unique across the graph.
36108           required: true
36109           type: string
36110           example: __VNF-ID__
36111         - name: interface-name
36112           in: path
36113           description: Name given to the interface
36114           required: true
36115           type: string
36116           example: __INTERFACE-NAME__
36117         - name: vlan-interface
36118           in: path
36119           description: String that identifies the interface
36120           required: true
36121           type: string
36122           example: __VLAN-INTERFACE__
36123         - name: resource-version
36124           in: query
36125           description: resource-version for concurrency
36126           required: true
36127           type: string
36128   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
36129     get:
36130       tags:
36131         - Network
36132       summary: returns vlans
36133       description: returns vlans
36134       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
36135       produces:
36136         - application/json
36137         - application/xml
36138       responses:
36139         "200":
36140           description: successful operation
36141           schema:
36142               $ref: "#/getDefinitions/vlans"
36143         "default":
36144           description: Response codes found in [response codes](https://wiki.onap.org/).
36145       parameters:
36146         - name: vnf-id
36147           in: path
36148           description: Unique id of VNF.  This is unique across the graph.
36149           required: true
36150           type: string
36151           example: __VNF-ID__
36152         - name: interface-name
36153           in: path
36154           description: Name given to the interface
36155           required: true
36156           type: string
36157           example: __INTERFACE-NAME__
36158         - name: vnf-name
36159           in: query
36160           description: Name of VNF.
36161           required: false
36162           type: string
36163         - name: vnf-name2
36164           in: query
36165           description: Alternate name of VNF.
36166           required: false
36167           type: string
36168         - name: vnf-type
36169           in: query
36170           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.
36171           required: false
36172           type: string
36173         - name: service-id
36174           in: query
36175           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36176           required: false
36177           type: string
36178         - name: regional-resource-zone
36179           in: query
36180           description: Regional way of organizing pservers, source of truth should define values
36181           required: false
36182           type: string
36183         - name: prov-status
36184           in: query
36185           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36186           required: false
36187           type: string
36188         - name: heat-stack-id
36189           in: query
36190           description: Heat stack id corresponding to this instance, managed by MSO
36191           required: false
36192           type: string
36193         - name: in-maint
36194           in: query
36195           required: false
36196           type: boolean
36197         - name: is-closed-loop-disabled
36198           in: query
36199           required: false
36200           type: boolean
36201         - name: model-invariant-id
36202           in: query
36203           description: the ASDC model id for this resource or service model.
36204           required: false
36205           type: string
36206         - name: model-version-id
36207           in: query
36208           description: the ASDC model version for this resource or service model.
36209           required: false
36210           type: string
36211         - name: widget-model-id
36212           in: query
36213           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36214           required: false
36215           type: string
36216         - name: widget-model-version
36217           in: query
36218           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36219           required: false
36220           type: string
36221         - name: nf-type
36222           in: query
36223           description: Generic description of the type of NF
36224           required: false
36225           type: string
36226         - name: nf-function
36227           in: query
36228           description: English description of Network function that the specific VNF deployment is providing
36229           required: false
36230           type: string
36231         - name: nf-role
36232           in: query
36233           description: role in the network that this model will be providing
36234           required: false
36235           type: string
36236         - name: nf-naming-code
36237           in: query
36238           description: string assigned to this model used for naming purposes
36239           required: false
36240           type: string
36241         - name: interface-id
36242           in: query
36243           description: ID of interface
36244           required: false
36245           type: string
36246         - name: macaddr
36247           in: query
36248           description: MAC address for the interface
36249           required: false
36250           type: string
36251         - name: network-name
36252           in: query
36253           description: Name of the network
36254           required: false
36255           type: string
36256   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
36257     put:
36258       tags:
36259         - Network
36260       summary: see node definition for valid relationships
36261       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36262       consumes:
36263         - application/json
36264         - application/xml
36265       produces:
36266         - application/json
36267         - application/xml
36268       responses:
36269         "default":
36270           description: Response codes found in [response codes](https://wiki.onap.org/).
36271       parameters:
36272         - name: vnf-id
36273           in: path
36274           description: Unique id of VNF.  This is unique across the graph.
36275           required: true
36276           type: string
36277           example: __VNF-ID__
36278         - name: interface-name
36279           in: path
36280           description: Name given to the interface
36281           required: true
36282           type: string
36283           example: __INTERFACE-NAME__
36284         - name: pci-id
36285           in: path
36286           description: PCI ID used to identify the sriov-vf
36287           required: true
36288           type: string
36289           example: __PCI-ID__
36290         - name: body
36291           in: body
36292           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
36293           required: true
36294           schema:
36295             $ref: "#/definitions/relationship"
36296     delete:
36297       tags:
36298         - Network
36299       summary: delete an existing relationship
36300       description: delete an existing relationship
36301       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36302       consumes:
36303         - application/json
36304         - application/xml
36305       produces:
36306         - application/json
36307         - application/xml
36308       responses:
36309         "default":
36310           description: Response codes found in [response codes](https://wiki.onap.org/).
36311       parameters:
36312         - name: vnf-id
36313           in: path
36314           description: Unique id of VNF.  This is unique across the graph.
36315           required: true
36316           type: string
36317           example: __VNF-ID__
36318         - name: interface-name
36319           in: path
36320           description: Name given to the interface
36321           required: true
36322           type: string
36323           example: __INTERFACE-NAME__
36324         - name: pci-id
36325           in: path
36326           description: PCI ID used to identify the sriov-vf
36327           required: true
36328           type: string
36329           example: __PCI-ID__
36330   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36331     get:
36332       tags:
36333         - Network
36334       summary: returns sriov-vf
36335       description: returns sriov-vf
36336       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36337       produces:
36338         - application/json
36339         - application/xml
36340       responses:
36341         "200":
36342           description: successful operation
36343           schema:
36344               $ref: "#/getDefinitions/sriov-vf"
36345         "default":
36346           description: Response codes found in [response codes](https://wiki.onap.org/).
36347       parameters:
36348         - name: vnf-id
36349           in: path
36350           description: Unique id of VNF.  This is unique across the graph.
36351           required: true
36352           type: string
36353           example: __VNF-ID__
36354         - name: interface-name
36355           in: path
36356           description: Name given to the interface
36357           required: true
36358           type: string
36359           example: __INTERFACE-NAME__
36360         - name: pci-id
36361           in: path
36362           description: PCI ID used to identify the sriov-vf
36363           required: true
36364           type: string
36365           example: __PCI-ID__
36366         - name: vnf-name
36367           in: query
36368           description: Name of VNF.
36369           required: false
36370           type: string
36371         - name: vnf-name2
36372           in: query
36373           description: Alternate name of VNF.
36374           required: false
36375           type: string
36376         - name: vnf-type
36377           in: query
36378           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.
36379           required: false
36380           type: string
36381         - name: service-id
36382           in: query
36383           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36384           required: false
36385           type: string
36386         - name: regional-resource-zone
36387           in: query
36388           description: Regional way of organizing pservers, source of truth should define values
36389           required: false
36390           type: string
36391         - name: prov-status
36392           in: query
36393           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36394           required: false
36395           type: string
36396         - name: heat-stack-id
36397           in: query
36398           description: Heat stack id corresponding to this instance, managed by MSO
36399           required: false
36400           type: string
36401         - name: in-maint
36402           in: query
36403           required: false
36404           type: boolean
36405         - name: is-closed-loop-disabled
36406           in: query
36407           required: false
36408           type: boolean
36409         - name: model-invariant-id
36410           in: query
36411           description: the ASDC model id for this resource or service model.
36412           required: false
36413           type: string
36414         - name: model-version-id
36415           in: query
36416           description: the ASDC model version for this resource or service model.
36417           required: false
36418           type: string
36419         - name: widget-model-id
36420           in: query
36421           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36422           required: false
36423           type: string
36424         - name: widget-model-version
36425           in: query
36426           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36427           required: false
36428           type: string
36429         - name: nf-type
36430           in: query
36431           description: Generic description of the type of NF
36432           required: false
36433           type: string
36434         - name: nf-function
36435           in: query
36436           description: English description of Network function that the specific VNF deployment is providing
36437           required: false
36438           type: string
36439         - name: nf-role
36440           in: query
36441           description: role in the network that this model will be providing
36442           required: false
36443           type: string
36444         - name: nf-naming-code
36445           in: query
36446           description: string assigned to this model used for naming purposes
36447           required: false
36448           type: string
36449         - name: interface-id
36450           in: query
36451           description: ID of interface
36452           required: false
36453           type: string
36454         - name: macaddr
36455           in: query
36456           description: MAC address for the interface
36457           required: false
36458           type: string
36459         - name: network-name
36460           in: query
36461           description: Name of the network
36462           required: false
36463           type: string
36464         - name: vf-vlan-filter
36465           in: query
36466           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
36467           required: false
36468           type: string
36469         - name: vf-mac-filter
36470           in: query
36471           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
36472           required: false
36473           type: string
36474         - name: vf-vlan-strip
36475           in: query
36476           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
36477           required: false
36478           type: boolean
36479         - name: neutron-network-id
36480           in: query
36481           description: Neutron network id of the interface
36482           required: false
36483           type: string
36484     put:
36485       tags:
36486         - Network
36487       summary: create or update an existing sriov-vf
36488       description: |
36489         Create or update an existing sriov-vf.
36490         #
36491         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
36492       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36493       consumes:
36494         - application/json
36495         - application/xml
36496       produces:
36497         - application/json
36498         - application/xml
36499       responses:
36500         "default":
36501           description: Response codes found in [response codes](https://wiki.onap.org/).
36502       parameters:
36503         - name: vnf-id
36504           in: path
36505           description: Unique id of VNF.  This is unique across the graph.
36506           required: true
36507           type: string
36508           example: __VNF-ID__
36509         - name: interface-name
36510           in: path
36511           description: Name given to the interface
36512           required: true
36513           type: string
36514           example: __INTERFACE-NAME__
36515         - name: pci-id
36516           in: path
36517           description: PCI ID used to identify the sriov-vf
36518           required: true
36519           type: string
36520           example: __PCI-ID__
36521         - name: body
36522           in: body
36523           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
36524           required: true
36525           schema:
36526             $ref: "#/definitions/sriov-vf"
36527     patch:
36528       tags:
36529         - Network
36530       summary: update an existing sriov-vf
36531       description: |
36532         Update an existing sriov-vf
36533         #
36534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36535         The PUT operation will entirely replace an existing object.
36536         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.
36537         #
36538         Other differences between PUT and PATCH are:
36539         #
36540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36543       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36544       consumes:
36545         - application/json
36546         - application/xml
36547       produces:
36548         - application/json
36549         - application/xml
36550       responses:
36551         "default":
36552           description: Response codes found in [response codes](https://wiki.onap.org/).
36553       parameters:
36554         - name: vnf-id
36555           in: path
36556           description: Unique id of VNF.  This is unique across the graph.
36557           required: true
36558           type: string
36559           example: __VNF-ID__
36560         - name: interface-name
36561           in: path
36562           description: Name given to the interface
36563           required: true
36564           type: string
36565           example: __INTERFACE-NAME__
36566         - name: pci-id
36567           in: path
36568           description: PCI ID used to identify the sriov-vf
36569           required: true
36570           type: string
36571           example: __PCI-ID__
36572         - name: body
36573           in: body
36574           description: sriov-vf object that needs to be created or updated.
36575           required: true
36576           schema:
36577             $ref: "#/patchDefinitions/sriov-vf"
36578     delete:
36579       tags:
36580         - Network
36581       summary: delete an existing sriov-vf
36582       description: delete an existing sriov-vf
36583       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
36584       consumes:
36585         - application/json
36586         - application/xml
36587       produces:
36588         - application/json
36589         - application/xml
36590       responses:
36591         "default":
36592           description: Response codes found in [response codes](https://wiki.onap.org/).
36593       parameters:
36594         - name: vnf-id
36595           in: path
36596           description: Unique id of VNF.  This is unique across the graph.
36597           required: true
36598           type: string
36599           example: __VNF-ID__
36600         - name: interface-name
36601           in: path
36602           description: Name given to the interface
36603           required: true
36604           type: string
36605           example: __INTERFACE-NAME__
36606         - name: pci-id
36607           in: path
36608           description: PCI ID used to identify the sriov-vf
36609           required: true
36610           type: string
36611           example: __PCI-ID__
36612         - name: resource-version
36613           in: query
36614           description: resource-version for concurrency
36615           required: true
36616           type: string
36617   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36618     get:
36619       tags:
36620         - Network
36621       summary: returns sriov-vfs
36622       description: returns sriov-vfs
36623       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
36624       produces:
36625         - application/json
36626         - application/xml
36627       responses:
36628         "200":
36629           description: successful operation
36630           schema:
36631               $ref: "#/getDefinitions/sriov-vfs"
36632         "default":
36633           description: Response codes found in [response codes](https://wiki.onap.org/).
36634       parameters:
36635         - name: vnf-id
36636           in: path
36637           description: Unique id of VNF.  This is unique across the graph.
36638           required: true
36639           type: string
36640           example: __VNF-ID__
36641         - name: interface-name
36642           in: path
36643           description: Name given to the interface
36644           required: true
36645           type: string
36646           example: __INTERFACE-NAME__
36647         - name: vnf-name
36648           in: query
36649           description: Name of VNF.
36650           required: false
36651           type: string
36652         - name: vnf-name2
36653           in: query
36654           description: Alternate name of VNF.
36655           required: false
36656           type: string
36657         - name: vnf-type
36658           in: query
36659           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.
36660           required: false
36661           type: string
36662         - name: service-id
36663           in: query
36664           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36665           required: false
36666           type: string
36667         - name: regional-resource-zone
36668           in: query
36669           description: Regional way of organizing pservers, source of truth should define values
36670           required: false
36671           type: string
36672         - name: prov-status
36673           in: query
36674           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36675           required: false
36676           type: string
36677         - name: heat-stack-id
36678           in: query
36679           description: Heat stack id corresponding to this instance, managed by MSO
36680           required: false
36681           type: string
36682         - name: in-maint
36683           in: query
36684           required: false
36685           type: boolean
36686         - name: is-closed-loop-disabled
36687           in: query
36688           required: false
36689           type: boolean
36690         - name: model-invariant-id
36691           in: query
36692           description: the ASDC model id for this resource or service model.
36693           required: false
36694           type: string
36695         - name: model-version-id
36696           in: query
36697           description: the ASDC model version for this resource or service model.
36698           required: false
36699           type: string
36700         - name: widget-model-id
36701           in: query
36702           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36703           required: false
36704           type: string
36705         - name: widget-model-version
36706           in: query
36707           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36708           required: false
36709           type: string
36710         - name: nf-type
36711           in: query
36712           description: Generic description of the type of NF
36713           required: false
36714           type: string
36715         - name: nf-function
36716           in: query
36717           description: English description of Network function that the specific VNF deployment is providing
36718           required: false
36719           type: string
36720         - name: nf-role
36721           in: query
36722           description: role in the network that this model will be providing
36723           required: false
36724           type: string
36725         - name: nf-naming-code
36726           in: query
36727           description: string assigned to this model used for naming purposes
36728           required: false
36729           type: string
36730         - name: interface-id
36731           in: query
36732           description: ID of interface
36733           required: false
36734           type: string
36735         - name: macaddr
36736           in: query
36737           description: MAC address for the interface
36738           required: false
36739           type: string
36740         - name: network-name
36741           in: query
36742           description: Name of the network
36743           required: false
36744           type: string
36745   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36746     put:
36747       tags:
36748         - Network
36749       summary: see node definition for valid relationships
36750       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
36751       consumes:
36752         - application/json
36753         - application/xml
36754       produces:
36755         - application/json
36756         - application/xml
36757       responses:
36758         "default":
36759           description: Response codes found in [response codes](https://wiki.onap.org/).
36760       parameters:
36761         - name: vnf-id
36762           in: path
36763           description: Unique id of VNF.  This is unique across the graph.
36764           required: true
36765           type: string
36766           example: __VNF-ID__
36767         - name: interface-name
36768           in: path
36769           description: Name given to the interface
36770           required: true
36771           type: string
36772           example: __INTERFACE-NAME__
36773         - name: body
36774           in: body
36775           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
36776           required: true
36777           schema:
36778             $ref: "#/definitions/relationship"
36779     delete:
36780       tags:
36781         - Network
36782       summary: delete an existing relationship
36783       description: delete an existing relationship
36784       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
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: vnf-id
36796           in: path
36797           description: Unique id of VNF.  This is unique across the graph.
36798           required: true
36799           type: string
36800           example: __VNF-ID__
36801         - name: interface-name
36802           in: path
36803           description: Name given to the interface
36804           required: true
36805           type: string
36806           example: __INTERFACE-NAME__
36807   /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:
36808     put:
36809       tags:
36810         - Network
36811       summary: see node definition for valid relationships
36812       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
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: vnf-id
36824           in: path
36825           description: Unique id of VNF.  This is unique across the graph.
36826           required: true
36827           type: string
36828           example: __VNF-ID__
36829         - name: interface-name
36830           in: path
36831           description: Name given to the interface
36832           required: true
36833           type: string
36834           example: __INTERFACE-NAME__
36835         - name: l3-interface-ipv4-address
36836           in: path
36837           description: IP address
36838           required: true
36839           type: string
36840           example: __L3-INTERFACE-IPV4-ADDRESS__
36841         - name: body
36842           in: body
36843           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36844           required: true
36845           schema:
36846             $ref: "#/definitions/relationship"
36847     delete:
36848       tags:
36849         - Network
36850       summary: delete an existing relationship
36851       description: delete an existing relationship
36852       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36853       consumes:
36854         - application/json
36855         - application/xml
36856       produces:
36857         - application/json
36858         - application/xml
36859       responses:
36860         "default":
36861           description: Response codes found in [response codes](https://wiki.onap.org/).
36862       parameters:
36863         - name: vnf-id
36864           in: path
36865           description: Unique id of VNF.  This is unique across the graph.
36866           required: true
36867           type: string
36868           example: __VNF-ID__
36869         - name: interface-name
36870           in: path
36871           description: Name given to the interface
36872           required: true
36873           type: string
36874           example: __INTERFACE-NAME__
36875         - name: l3-interface-ipv4-address
36876           in: path
36877           description: IP address
36878           required: true
36879           type: string
36880           example: __L3-INTERFACE-IPV4-ADDRESS__
36881   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
36882     get:
36883       tags:
36884         - Network
36885       summary: returns l3-interface-ipv4-address-list
36886       description: returns l3-interface-ipv4-address-list
36887       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36888       produces:
36889         - application/json
36890         - application/xml
36891       responses:
36892         "200":
36893           description: successful operation
36894           schema:
36895               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36896         "default":
36897           description: Response codes found in [response codes](https://wiki.onap.org/).
36898       parameters:
36899         - name: vnf-id
36900           in: path
36901           description: Unique id of VNF.  This is unique across the graph.
36902           required: true
36903           type: string
36904           example: __VNF-ID__
36905         - name: interface-name
36906           in: path
36907           description: Name given to the interface
36908           required: true
36909           type: string
36910           example: __INTERFACE-NAME__
36911         - name: l3-interface-ipv4-address
36912           in: path
36913           description: IP address
36914           required: true
36915           type: string
36916           example: __L3-INTERFACE-IPV4-ADDRESS__
36917         - name: vnf-name
36918           in: query
36919           description: Name of VNF.
36920           required: false
36921           type: string
36922         - name: vnf-name2
36923           in: query
36924           description: Alternate name of VNF.
36925           required: false
36926           type: string
36927         - name: vnf-type
36928           in: query
36929           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.
36930           required: false
36931           type: string
36932         - name: service-id
36933           in: query
36934           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36935           required: false
36936           type: string
36937         - name: regional-resource-zone
36938           in: query
36939           description: Regional way of organizing pservers, source of truth should define values
36940           required: false
36941           type: string
36942         - name: prov-status
36943           in: query
36944           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36945           required: false
36946           type: string
36947         - name: heat-stack-id
36948           in: query
36949           description: Heat stack id corresponding to this instance, managed by MSO
36950           required: false
36951           type: string
36952         - name: in-maint
36953           in: query
36954           required: false
36955           type: boolean
36956         - name: is-closed-loop-disabled
36957           in: query
36958           required: false
36959           type: boolean
36960         - name: model-invariant-id
36961           in: query
36962           description: the ASDC model id for this resource or service model.
36963           required: false
36964           type: string
36965         - name: model-version-id
36966           in: query
36967           description: the ASDC model version for this resource or service model.
36968           required: false
36969           type: string
36970         - name: widget-model-id
36971           in: query
36972           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36973           required: false
36974           type: string
36975         - name: widget-model-version
36976           in: query
36977           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36978           required: false
36979           type: string
36980         - name: nf-type
36981           in: query
36982           description: Generic description of the type of NF
36983           required: false
36984           type: string
36985         - name: nf-function
36986           in: query
36987           description: English description of Network function that the specific VNF deployment is providing
36988           required: false
36989           type: string
36990         - name: nf-role
36991           in: query
36992           description: role in the network that this model will be providing
36993           required: false
36994           type: string
36995         - name: nf-naming-code
36996           in: query
36997           description: string assigned to this model used for naming purposes
36998           required: false
36999           type: string
37000         - name: interface-id
37001           in: query
37002           description: ID of interface
37003           required: false
37004           type: string
37005         - name: macaddr
37006           in: query
37007           description: MAC address for the interface
37008           required: false
37009           type: string
37010         - name: network-name
37011           in: query
37012           description: Name of the network
37013           required: false
37014           type: string
37015         - name: vlan-id-inner
37016           in: query
37017           description: Inner VLAN tag
37018           required: false
37019           type: integer
37020           format: int64
37021         - name: neutron-network-id
37022           in: query
37023           description: Neutron network id of the interface that address belongs to
37024           required: false
37025           type: string
37026         - name: neutron-subnet-id
37027           in: query
37028           description: Neutron id of subnet that address belongs to
37029           required: false
37030           type: string
37031     put:
37032       tags:
37033         - Network
37034       summary: create or update an existing l3-interface-ipv4-address-list
37035       description: |
37036         Create or update an existing l3-interface-ipv4-address-list.
37037         #
37038         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
37039       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37040       consumes:
37041         - application/json
37042         - application/xml
37043       produces:
37044         - application/json
37045         - application/xml
37046       responses:
37047         "default":
37048           description: Response codes found in [response codes](https://wiki.onap.org/).
37049       parameters:
37050         - name: vnf-id
37051           in: path
37052           description: Unique id of VNF.  This is unique across the graph.
37053           required: true
37054           type: string
37055           example: __VNF-ID__
37056         - name: interface-name
37057           in: path
37058           description: Name given to the interface
37059           required: true
37060           type: string
37061           example: __INTERFACE-NAME__
37062         - name: l3-interface-ipv4-address
37063           in: path
37064           description: IP address
37065           required: true
37066           type: string
37067           example: __L3-INTERFACE-IPV4-ADDRESS__
37068         - name: body
37069           in: body
37070           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
37071           required: true
37072           schema:
37073             $ref: "#/definitions/l3-interface-ipv4-address-list"
37074     patch:
37075       tags:
37076         - Network
37077       summary: update an existing l3-interface-ipv4-address-list
37078       description: |
37079         Update an existing l3-interface-ipv4-address-list
37080         #
37081         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37082         The PUT operation will entirely replace an existing object.
37083         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.
37084         #
37085         Other differences between PUT and PATCH are:
37086         #
37087         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37088         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37089         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37090       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37091       consumes:
37092         - application/json
37093         - application/xml
37094       produces:
37095         - application/json
37096         - application/xml
37097       responses:
37098         "default":
37099           description: Response codes found in [response codes](https://wiki.onap.org/).
37100       parameters:
37101         - name: vnf-id
37102           in: path
37103           description: Unique id of VNF.  This is unique across the graph.
37104           required: true
37105           type: string
37106           example: __VNF-ID__
37107         - name: interface-name
37108           in: path
37109           description: Name given to the interface
37110           required: true
37111           type: string
37112           example: __INTERFACE-NAME__
37113         - name: l3-interface-ipv4-address
37114           in: path
37115           description: IP address
37116           required: true
37117           type: string
37118           example: __L3-INTERFACE-IPV4-ADDRESS__
37119         - name: body
37120           in: body
37121           description: l3-interface-ipv4-address-list object that needs to be created or updated.
37122           required: true
37123           schema:
37124             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37125     delete:
37126       tags:
37127         - Network
37128       summary: delete an existing l3-interface-ipv4-address-list
37129       description: delete an existing l3-interface-ipv4-address-list
37130       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
37131       consumes:
37132         - application/json
37133         - application/xml
37134       produces:
37135         - application/json
37136         - application/xml
37137       responses:
37138         "default":
37139           description: Response codes found in [response codes](https://wiki.onap.org/).
37140       parameters:
37141         - name: vnf-id
37142           in: path
37143           description: Unique id of VNF.  This is unique across the graph.
37144           required: true
37145           type: string
37146           example: __VNF-ID__
37147         - name: interface-name
37148           in: path
37149           description: Name given to the interface
37150           required: true
37151           type: string
37152           example: __INTERFACE-NAME__
37153         - name: l3-interface-ipv4-address
37154           in: path
37155           description: IP address
37156           required: true
37157           type: string
37158           example: __L3-INTERFACE-IPV4-ADDRESS__
37159         - name: resource-version
37160           in: query
37161           description: resource-version for concurrency
37162           required: true
37163           type: string
37164   /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:
37165     put:
37166       tags:
37167         - Network
37168       summary: see node definition for valid relationships
37169       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37170       consumes:
37171         - application/json
37172         - application/xml
37173       produces:
37174         - application/json
37175         - application/xml
37176       responses:
37177         "default":
37178           description: Response codes found in [response codes](https://wiki.onap.org/).
37179       parameters:
37180         - name: vnf-id
37181           in: path
37182           description: Unique id of VNF.  This is unique across the graph.
37183           required: true
37184           type: string
37185           example: __VNF-ID__
37186         - name: interface-name
37187           in: path
37188           description: Name given to the interface
37189           required: true
37190           type: string
37191           example: __INTERFACE-NAME__
37192         - name: l3-interface-ipv6-address
37193           in: path
37194           description: IP address
37195           required: true
37196           type: string
37197           example: __L3-INTERFACE-IPV6-ADDRESS__
37198         - name: body
37199           in: body
37200           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37201           required: true
37202           schema:
37203             $ref: "#/definitions/relationship"
37204     delete:
37205       tags:
37206         - Network
37207       summary: delete an existing relationship
37208       description: delete an existing relationship
37209       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
37210       consumes:
37211         - application/json
37212         - application/xml
37213       produces:
37214         - application/json
37215         - application/xml
37216       responses:
37217         "default":
37218           description: Response codes found in [response codes](https://wiki.onap.org/).
37219       parameters:
37220         - name: vnf-id
37221           in: path
37222           description: Unique id of VNF.  This is unique across the graph.
37223           required: true
37224           type: string
37225           example: __VNF-ID__
37226         - name: interface-name
37227           in: path
37228           description: Name given to the interface
37229           required: true
37230           type: string
37231           example: __INTERFACE-NAME__
37232         - name: l3-interface-ipv6-address
37233           in: path
37234           description: IP address
37235           required: true
37236           type: string
37237           example: __L3-INTERFACE-IPV6-ADDRESS__
37238   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37239     get:
37240       tags:
37241         - Network
37242       summary: returns l3-interface-ipv6-address-list
37243       description: returns l3-interface-ipv6-address-list
37244       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37245       produces:
37246         - application/json
37247         - application/xml
37248       responses:
37249         "200":
37250           description: successful operation
37251           schema:
37252               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37253         "default":
37254           description: Response codes found in [response codes](https://wiki.onap.org/).
37255       parameters:
37256         - name: vnf-id
37257           in: path
37258           description: Unique id of VNF.  This is unique across the graph.
37259           required: true
37260           type: string
37261           example: __VNF-ID__
37262         - name: interface-name
37263           in: path
37264           description: Name given to the interface
37265           required: true
37266           type: string
37267           example: __INTERFACE-NAME__
37268         - name: l3-interface-ipv6-address
37269           in: path
37270           description: IP address
37271           required: true
37272           type: string
37273           example: __L3-INTERFACE-IPV6-ADDRESS__
37274         - name: vnf-name
37275           in: query
37276           description: Name of VNF.
37277           required: false
37278           type: string
37279         - name: vnf-name2
37280           in: query
37281           description: Alternate name of VNF.
37282           required: false
37283           type: string
37284         - name: vnf-type
37285           in: query
37286           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.
37287           required: false
37288           type: string
37289         - name: service-id
37290           in: query
37291           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37292           required: false
37293           type: string
37294         - name: regional-resource-zone
37295           in: query
37296           description: Regional way of organizing pservers, source of truth should define values
37297           required: false
37298           type: string
37299         - name: prov-status
37300           in: query
37301           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37302           required: false
37303           type: string
37304         - name: heat-stack-id
37305           in: query
37306           description: Heat stack id corresponding to this instance, managed by MSO
37307           required: false
37308           type: string
37309         - name: in-maint
37310           in: query
37311           required: false
37312           type: boolean
37313         - name: is-closed-loop-disabled
37314           in: query
37315           required: false
37316           type: boolean
37317         - name: model-invariant-id
37318           in: query
37319           description: the ASDC model id for this resource or service model.
37320           required: false
37321           type: string
37322         - name: model-version-id
37323           in: query
37324           description: the ASDC model version for this resource or service model.
37325           required: false
37326           type: string
37327         - name: widget-model-id
37328           in: query
37329           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37330           required: false
37331           type: string
37332         - name: widget-model-version
37333           in: query
37334           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37335           required: false
37336           type: string
37337         - name: nf-type
37338           in: query
37339           description: Generic description of the type of NF
37340           required: false
37341           type: string
37342         - name: nf-function
37343           in: query
37344           description: English description of Network function that the specific VNF deployment is providing
37345           required: false
37346           type: string
37347         - name: nf-role
37348           in: query
37349           description: role in the network that this model will be providing
37350           required: false
37351           type: string
37352         - name: nf-naming-code
37353           in: query
37354           description: string assigned to this model used for naming purposes
37355           required: false
37356           type: string
37357         - name: interface-id
37358           in: query
37359           description: ID of interface
37360           required: false
37361           type: string
37362         - name: macaddr
37363           in: query
37364           description: MAC address for the interface
37365           required: false
37366           type: string
37367         - name: network-name
37368           in: query
37369           description: Name of the network
37370           required: false
37371           type: string
37372         - name: vlan-id-inner
37373           in: query
37374           description: Inner VLAN tag
37375           required: false
37376           type: integer
37377           format: int64
37378         - name: neutron-network-id
37379           in: query
37380           description: Neutron network id of the interface that address belongs to
37381           required: false
37382           type: string
37383         - name: neutron-subnet-id
37384           in: query
37385           description: Neutron id of subnet that address belongs to
37386           required: false
37387           type: string
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: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
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-id
37408           in: path
37409           description: Unique id of VNF.  This is unique across the graph.
37410           required: true
37411           type: string
37412           example: __VNF-ID__
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: l3-interface-ipv6-address
37420           in: path
37421           description: IP address
37422           required: true
37423           type: string
37424           example: __L3-INTERFACE-IPV6-ADDRESS__
37425         - name: body
37426           in: body
37427           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
37428           required: true
37429           schema:
37430             $ref: "#/definitions/l3-interface-ipv6-address-list"
37431     patch:
37432       tags:
37433         - Network
37434       summary: update an existing l3-interface-ipv6-address-list
37435       description: |
37436         Update an existing l3-interface-ipv6-address-list
37437         #
37438         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37439         The PUT operation will entirely replace an existing object.
37440         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.
37441         #
37442         Other differences between PUT and PATCH are:
37443         #
37444         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37445         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37446         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37447       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37448       consumes:
37449         - application/json
37450         - application/xml
37451       produces:
37452         - application/json
37453         - application/xml
37454       responses:
37455         "default":
37456           description: Response codes found in [response codes](https://wiki.onap.org/).
37457       parameters:
37458         - name: vnf-id
37459           in: path
37460           description: Unique id of VNF.  This is unique across the graph.
37461           required: true
37462           type: string
37463           example: __VNF-ID__
37464         - name: interface-name
37465           in: path
37466           description: Name given to the interface
37467           required: true
37468           type: string
37469           example: __INTERFACE-NAME__
37470         - name: l3-interface-ipv6-address
37471           in: path
37472           description: IP address
37473           required: true
37474           type: string
37475           example: __L3-INTERFACE-IPV6-ADDRESS__
37476         - name: body
37477           in: body
37478           description: l3-interface-ipv6-address-list object that needs to be created or updated.
37479           required: true
37480           schema:
37481             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37482     delete:
37483       tags:
37484         - Network
37485       summary: delete an existing l3-interface-ipv6-address-list
37486       description: delete an existing l3-interface-ipv6-address-list
37487       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
37488       consumes:
37489         - application/json
37490         - application/xml
37491       produces:
37492         - application/json
37493         - application/xml
37494       responses:
37495         "default":
37496           description: Response codes found in [response codes](https://wiki.onap.org/).
37497       parameters:
37498         - name: vnf-id
37499           in: path
37500           description: Unique id of VNF.  This is unique across the graph.
37501           required: true
37502           type: string
37503           example: __VNF-ID__
37504         - name: interface-name
37505           in: path
37506           description: Name given to the interface
37507           required: true
37508           type: string
37509           example: __INTERFACE-NAME__
37510         - name: l3-interface-ipv6-address
37511           in: path
37512           description: IP address
37513           required: true
37514           type: string
37515           example: __L3-INTERFACE-IPV6-ADDRESS__
37516         - name: resource-version
37517           in: query
37518           description: resource-version for concurrency
37519           required: true
37520           type: string
37521   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
37522     get:
37523       tags:
37524         - Network
37525       summary: returns l-interface
37526       description: returns l-interface
37527       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
37528       produces:
37529         - application/json
37530         - application/xml
37531       responses:
37532         "200":
37533           description: successful operation
37534           schema:
37535               $ref: "#/getDefinitions/l-interface"
37536         "default":
37537           description: Response codes found in [response codes](https://wiki.onap.org/).
37538       parameters:
37539         - name: vnf-id
37540           in: path
37541           description: Unique id of VNF.  This is unique across the graph.
37542           required: true
37543           type: string
37544           example: __VNF-ID__
37545         - name: interface-name
37546           in: path
37547           description: Name given to the interface
37548           required: true
37549           type: string
37550           example: __INTERFACE-NAME__
37551         - name: vnf-name
37552           in: query
37553           description: Name of VNF.
37554           required: false
37555           type: string
37556         - name: vnf-name2
37557           in: query
37558           description: Alternate name of VNF.
37559           required: false
37560           type: string
37561         - name: vnf-type
37562           in: query
37563           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.
37564           required: false
37565           type: string
37566         - name: service-id
37567           in: query
37568           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37569           required: false
37570           type: string
37571         - name: regional-resource-zone
37572           in: query
37573           description: Regional way of organizing pservers, source of truth should define values
37574           required: false
37575           type: string
37576         - name: prov-status
37577           in: query
37578           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37579           required: false
37580           type: string
37581         - name: heat-stack-id
37582           in: query
37583           description: Heat stack id corresponding to this instance, managed by MSO
37584           required: false
37585           type: string
37586         - name: in-maint
37587           in: query
37588           required: false
37589           type: boolean
37590         - name: is-closed-loop-disabled
37591           in: query
37592           required: false
37593           type: boolean
37594         - name: model-invariant-id
37595           in: query
37596           description: the ASDC model id for this resource or service model.
37597           required: false
37598           type: string
37599         - name: model-version-id
37600           in: query
37601           description: the ASDC model version for this resource or service model.
37602           required: false
37603           type: string
37604         - name: widget-model-id
37605           in: query
37606           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37607           required: false
37608           type: string
37609         - name: widget-model-version
37610           in: query
37611           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37612           required: false
37613           type: string
37614         - name: nf-type
37615           in: query
37616           description: Generic description of the type of NF
37617           required: false
37618           type: string
37619         - name: nf-function
37620           in: query
37621           description: English description of Network function that the specific VNF deployment is providing
37622           required: false
37623           type: string
37624         - name: nf-role
37625           in: query
37626           description: role in the network that this model will be providing
37627           required: false
37628           type: string
37629         - name: nf-naming-code
37630           in: query
37631           description: string assigned to this model used for naming purposes
37632           required: false
37633           type: string
37634         - name: interface-id
37635           in: query
37636           description: ID of interface
37637           required: false
37638           type: string
37639         - name: macaddr
37640           in: query
37641           description: MAC address for the interface
37642           required: false
37643           type: string
37644         - name: network-name
37645           in: query
37646           description: Name of the network
37647           required: false
37648           type: string
37649     put:
37650       tags:
37651         - Network
37652       summary: create or update an existing l-interface
37653       description: |
37654         Create or update an existing l-interface.
37655         #
37656         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
37657       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
37658       consumes:
37659         - application/json
37660         - application/xml
37661       produces:
37662         - application/json
37663         - application/xml
37664       responses:
37665         "default":
37666           description: Response codes found in [response codes](https://wiki.onap.org/).
37667       parameters:
37668         - name: vnf-id
37669           in: path
37670           description: Unique id of VNF.  This is unique across the graph.
37671           required: true
37672           type: string
37673           example: __VNF-ID__
37674         - name: interface-name
37675           in: path
37676           description: Name given to the interface
37677           required: true
37678           type: string
37679           example: __INTERFACE-NAME__
37680         - name: body
37681           in: body
37682           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
37683           required: true
37684           schema:
37685             $ref: "#/definitions/l-interface"
37686     patch:
37687       tags:
37688         - Network
37689       summary: update an existing l-interface
37690       description: |
37691         Update an existing l-interface
37692         #
37693         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37694         The PUT operation will entirely replace an existing object.
37695         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.
37696         #
37697         Other differences between PUT and PATCH are:
37698         #
37699         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37700         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37701         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37702       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
37703       consumes:
37704         - application/json
37705         - application/xml
37706       produces:
37707         - application/json
37708         - application/xml
37709       responses:
37710         "default":
37711           description: Response codes found in [response codes](https://wiki.onap.org/).
37712       parameters:
37713         - name: vnf-id
37714           in: path
37715           description: Unique id of VNF.  This is unique across the graph.
37716           required: true
37717           type: string
37718           example: __VNF-ID__
37719         - name: interface-name
37720           in: path
37721           description: Name given to the interface
37722           required: true
37723           type: string
37724           example: __INTERFACE-NAME__
37725         - name: body
37726           in: body
37727           description: l-interface object that needs to be created or updated.
37728           required: true
37729           schema:
37730             $ref: "#/patchDefinitions/l-interface"
37731     delete:
37732       tags:
37733         - Network
37734       summary: delete an existing l-interface
37735       description: delete an existing l-interface
37736       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
37737       consumes:
37738         - application/json
37739         - application/xml
37740       produces:
37741         - application/json
37742         - application/xml
37743       responses:
37744         "default":
37745           description: Response codes found in [response codes](https://wiki.onap.org/).
37746       parameters:
37747         - name: vnf-id
37748           in: path
37749           description: Unique id of VNF.  This is unique across the graph.
37750           required: true
37751           type: string
37752           example: __VNF-ID__
37753         - name: interface-name
37754           in: path
37755           description: Name given to the interface
37756           required: true
37757           type: string
37758           example: __INTERFACE-NAME__
37759         - name: resource-version
37760           in: query
37761           description: resource-version for concurrency
37762           required: true
37763           type: string
37764   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
37765     get:
37766       tags:
37767         - Network
37768       summary: returns l-interfaces
37769       description: returns l-interfaces
37770       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
37771       produces:
37772         - application/json
37773         - application/xml
37774       responses:
37775         "200":
37776           description: successful operation
37777           schema:
37778               $ref: "#/getDefinitions/l-interfaces"
37779         "default":
37780           description: Response codes found in [response codes](https://wiki.onap.org/).
37781       parameters:
37782         - name: vnf-id
37783           in: path
37784           description: Unique id of VNF.  This is unique across the graph.
37785           required: true
37786           type: string
37787           example: __VNF-ID__
37788         - name: vnf-name
37789           in: query
37790           description: Name of VNF.
37791           required: false
37792           type: string
37793         - name: vnf-name2
37794           in: query
37795           description: Alternate name of VNF.
37796           required: false
37797           type: string
37798         - name: vnf-type
37799           in: query
37800           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.
37801           required: false
37802           type: string
37803         - name: service-id
37804           in: query
37805           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37806           required: false
37807           type: string
37808         - name: regional-resource-zone
37809           in: query
37810           description: Regional way of organizing pservers, source of truth should define values
37811           required: false
37812           type: string
37813         - name: prov-status
37814           in: query
37815           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37816           required: false
37817           type: string
37818         - name: heat-stack-id
37819           in: query
37820           description: Heat stack id corresponding to this instance, managed by MSO
37821           required: false
37822           type: string
37823         - name: in-maint
37824           in: query
37825           required: false
37826           type: boolean
37827         - name: is-closed-loop-disabled
37828           in: query
37829           required: false
37830           type: boolean
37831         - name: model-invariant-id
37832           in: query
37833           description: the ASDC model id for this resource or service model.
37834           required: false
37835           type: string
37836         - name: model-version-id
37837           in: query
37838           description: the ASDC model version for this resource or service model.
37839           required: false
37840           type: string
37841         - name: widget-model-id
37842           in: query
37843           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37844           required: false
37845           type: string
37846         - name: widget-model-version
37847           in: query
37848           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37849           required: false
37850           type: string
37851         - name: nf-type
37852           in: query
37853           description: Generic description of the type of NF
37854           required: false
37855           type: string
37856         - name: nf-function
37857           in: query
37858           description: English description of Network function that the specific VNF deployment is providing
37859           required: false
37860           type: string
37861         - name: nf-role
37862           in: query
37863           description: role in the network that this model will be providing
37864           required: false
37865           type: string
37866         - name: nf-naming-code
37867           in: query
37868           description: string assigned to this model used for naming purposes
37869           required: false
37870           type: string
37871   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
37872     put:
37873       tags:
37874         - Network
37875       summary: see node definition for valid relationships
37876       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
37877       consumes:
37878         - application/json
37879         - application/xml
37880       produces:
37881         - application/json
37882         - application/xml
37883       responses:
37884         "default":
37885           description: Response codes found in [response codes](https://wiki.onap.org/).
37886       parameters:
37887         - name: vnf-id
37888           in: path
37889           description: Unique id of VNF.  This is unique across the graph.
37890           required: true
37891           type: string
37892           example: __VNF-ID__
37893         - name: interface-name
37894           in: path
37895           description: Name that identifies the link aggregate interface
37896           required: true
37897           type: string
37898           example: __INTERFACE-NAME__
37899         - name: body
37900           in: body
37901           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
37902           required: true
37903           schema:
37904             $ref: "#/definitions/relationship"
37905     delete:
37906       tags:
37907         - Network
37908       summary: delete an existing relationship
37909       description: delete an existing relationship
37910       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
37911       consumes:
37912         - application/json
37913         - application/xml
37914       produces:
37915         - application/json
37916         - application/xml
37917       responses:
37918         "default":
37919           description: Response codes found in [response codes](https://wiki.onap.org/).
37920       parameters:
37921         - name: vnf-id
37922           in: path
37923           description: Unique id of VNF.  This is unique across the graph.
37924           required: true
37925           type: string
37926           example: __VNF-ID__
37927         - name: interface-name
37928           in: path
37929           description: Name that identifies the link aggregate interface
37930           required: true
37931           type: string
37932           example: __INTERFACE-NAME__
37933   /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:
37934     put:
37935       tags:
37936         - Network
37937       summary: see node definition for valid relationships
37938       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37939       consumes:
37940         - application/json
37941         - application/xml
37942       produces:
37943         - application/json
37944         - application/xml
37945       responses:
37946         "default":
37947           description: Response codes found in [response codes](https://wiki.onap.org/).
37948       parameters:
37949         - name: vnf-id
37950           in: path
37951           description: Unique id of VNF.  This is unique across the graph.
37952           required: true
37953           type: string
37954           example: __VNF-ID__
37955         - name: interface-name
37956           in: path
37957           description: Name that identifies the link aggregate interface
37958           required: true
37959           type: string
37960           example: __INTERFACE-NAME__
37961         - name: interface-name
37962           in: path
37963           description: Name given to the interface
37964           required: true
37965           type: string
37966           example: __INTERFACE-NAME__
37967         - name: vlan-interface
37968           in: path
37969           description: String that identifies the interface
37970           required: true
37971           type: string
37972           example: __VLAN-INTERFACE__
37973         - name: body
37974           in: body
37975           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37976           required: true
37977           schema:
37978             $ref: "#/definitions/relationship"
37979     delete:
37980       tags:
37981         - Network
37982       summary: delete an existing relationship
37983       description: delete an existing relationship
37984       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37985       consumes:
37986         - application/json
37987         - application/xml
37988       produces:
37989         - application/json
37990         - application/xml
37991       responses:
37992         "default":
37993           description: Response codes found in [response codes](https://wiki.onap.org/).
37994       parameters:
37995         - name: vnf-id
37996           in: path
37997           description: Unique id of VNF.  This is unique across the graph.
37998           required: true
37999           type: string
38000           example: __VNF-ID__
38001         - name: interface-name
38002           in: path
38003           description: Name that identifies the link aggregate interface
38004           required: true
38005           type: string
38006           example: __INTERFACE-NAME__
38007         - name: interface-name
38008           in: path
38009           description: Name given to the interface
38010           required: true
38011           type: string
38012           example: __INTERFACE-NAME__
38013         - name: vlan-interface
38014           in: path
38015           description: String that identifies the interface
38016           required: true
38017           type: string
38018           example: __VLAN-INTERFACE__
38019   /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:
38020     put:
38021       tags:
38022         - Network
38023       summary: see node definition for valid relationships
38024       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38025       consumes:
38026         - application/json
38027         - application/xml
38028       produces:
38029         - application/json
38030         - application/xml
38031       responses:
38032         "default":
38033           description: Response codes found in [response codes](https://wiki.onap.org/).
38034       parameters:
38035         - name: vnf-id
38036           in: path
38037           description: Unique id of VNF.  This is unique across the graph.
38038           required: true
38039           type: string
38040           example: __VNF-ID__
38041         - name: interface-name
38042           in: path
38043           description: Name that identifies the link aggregate interface
38044           required: true
38045           type: string
38046           example: __INTERFACE-NAME__
38047         - name: interface-name
38048           in: path
38049           description: Name given to the interface
38050           required: true
38051           type: string
38052           example: __INTERFACE-NAME__
38053         - name: vlan-interface
38054           in: path
38055           description: String that identifies the interface
38056           required: true
38057           type: string
38058           example: __VLAN-INTERFACE__
38059         - name: l3-interface-ipv4-address
38060           in: path
38061           description: IP address
38062           required: true
38063           type: string
38064           example: __L3-INTERFACE-IPV4-ADDRESS__
38065         - name: body
38066           in: body
38067           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38068           required: true
38069           schema:
38070             $ref: "#/definitions/relationship"
38071     delete:
38072       tags:
38073         - Network
38074       summary: delete an existing relationship
38075       description: delete an existing relationship
38076       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38077       consumes:
38078         - application/json
38079         - application/xml
38080       produces:
38081         - application/json
38082         - application/xml
38083       responses:
38084         "default":
38085           description: Response codes found in [response codes](https://wiki.onap.org/).
38086       parameters:
38087         - name: vnf-id
38088           in: path
38089           description: Unique id of VNF.  This is unique across the graph.
38090           required: true
38091           type: string
38092           example: __VNF-ID__
38093         - name: interface-name
38094           in: path
38095           description: Name that identifies the link aggregate interface
38096           required: true
38097           type: string
38098           example: __INTERFACE-NAME__
38099         - name: interface-name
38100           in: path
38101           description: Name given to the interface
38102           required: true
38103           type: string
38104           example: __INTERFACE-NAME__
38105         - name: vlan-interface
38106           in: path
38107           description: String that identifies the interface
38108           required: true
38109           type: string
38110           example: __VLAN-INTERFACE__
38111         - name: l3-interface-ipv4-address
38112           in: path
38113           description: IP address
38114           required: true
38115           type: string
38116           example: __L3-INTERFACE-IPV4-ADDRESS__
38117   /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}:
38118     get:
38119       tags:
38120         - Network
38121       summary: returns l3-interface-ipv4-address-list
38122       description: returns l3-interface-ipv4-address-list
38123       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38124       produces:
38125         - application/json
38126         - application/xml
38127       responses:
38128         "200":
38129           description: successful operation
38130           schema:
38131               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38132         "default":
38133           description: Response codes found in [response codes](https://wiki.onap.org/).
38134       parameters:
38135         - name: vnf-id
38136           in: path
38137           description: Unique id of VNF.  This is unique across the graph.
38138           required: true
38139           type: string
38140           example: __VNF-ID__
38141         - name: interface-name
38142           in: path
38143           description: Name that identifies the link aggregate interface
38144           required: true
38145           type: string
38146           example: __INTERFACE-NAME__
38147         - name: interface-name
38148           in: path
38149           description: Name given to the interface
38150           required: true
38151           type: string
38152           example: __INTERFACE-NAME__
38153         - name: vlan-interface
38154           in: path
38155           description: String that identifies the interface
38156           required: true
38157           type: string
38158           example: __VLAN-INTERFACE__
38159         - name: l3-interface-ipv4-address
38160           in: path
38161           description: IP address
38162           required: true
38163           type: string
38164           example: __L3-INTERFACE-IPV4-ADDRESS__
38165         - name: vnf-name
38166           in: query
38167           description: Name of VNF.
38168           required: false
38169           type: string
38170         - name: vnf-name2
38171           in: query
38172           description: Alternate name of VNF.
38173           required: false
38174           type: string
38175         - name: vnf-type
38176           in: query
38177           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.
38178           required: false
38179           type: string
38180         - name: service-id
38181           in: query
38182           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38183           required: false
38184           type: string
38185         - name: regional-resource-zone
38186           in: query
38187           description: Regional way of organizing pservers, source of truth should define values
38188           required: false
38189           type: string
38190         - name: prov-status
38191           in: query
38192           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38193           required: false
38194           type: string
38195         - name: heat-stack-id
38196           in: query
38197           description: Heat stack id corresponding to this instance, managed by MSO
38198           required: false
38199           type: string
38200         - name: in-maint
38201           in: query
38202           required: false
38203           type: boolean
38204         - name: is-closed-loop-disabled
38205           in: query
38206           required: false
38207           type: boolean
38208         - name: model-invariant-id
38209           in: query
38210           description: the ASDC model id for this resource or service model.
38211           required: false
38212           type: string
38213         - name: model-version-id
38214           in: query
38215           description: the ASDC model version for this resource or service model.
38216           required: false
38217           type: string
38218         - name: widget-model-id
38219           in: query
38220           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38221           required: false
38222           type: string
38223         - name: widget-model-version
38224           in: query
38225           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38226           required: false
38227           type: string
38228         - name: nf-type
38229           in: query
38230           description: Generic description of the type of NF
38231           required: false
38232           type: string
38233         - name: nf-function
38234           in: query
38235           description: English description of Network function that the specific VNF deployment is providing
38236           required: false
38237           type: string
38238         - name: nf-role
38239           in: query
38240           description: role in the network that this model will be providing
38241           required: false
38242           type: string
38243         - name: nf-naming-code
38244           in: query
38245           description: string assigned to this model used for naming purposes
38246           required: false
38247           type: string
38248         - name: interface-id
38249           in: query
38250           description: ID of interface
38251           required: false
38252           type: string
38253         - name: interface-role
38254           in: query
38255           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38256           required: false
38257           type: string
38258         - name: interface-id
38259           in: query
38260           description: ID of interface
38261           required: false
38262           type: string
38263         - name: macaddr
38264           in: query
38265           description: MAC address for the interface
38266           required: false
38267           type: string
38268         - name: network-name
38269           in: query
38270           description: Name of the network
38271           required: false
38272           type: string
38273         - name: vlan-id-inner
38274           in: query
38275           description: Inner VLAN tag
38276           required: false
38277           type: integer
38278           format: int64
38279         - name: vpn-key
38280           in: query
38281           description: This indicates the customers VPN ID associated with this vlan
38282           required: false
38283           type: string
38284         - name: vlan-id-inner
38285           in: query
38286           description: Inner VLAN tag
38287           required: false
38288           type: integer
38289           format: int64
38290         - name: neutron-network-id
38291           in: query
38292           description: Neutron network id of the interface that address belongs to
38293           required: false
38294           type: string
38295         - name: neutron-subnet-id
38296           in: query
38297           description: Neutron id of subnet that address belongs to
38298           required: false
38299           type: string
38300     put:
38301       tags:
38302         - Network
38303       summary: create or update an existing l3-interface-ipv4-address-list
38304       description: |
38305         Create or update an existing l3-interface-ipv4-address-list.
38306         #
38307         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
38308       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38309       consumes:
38310         - application/json
38311         - application/xml
38312       produces:
38313         - application/json
38314         - application/xml
38315       responses:
38316         "default":
38317           description: Response codes found in [response codes](https://wiki.onap.org/).
38318       parameters:
38319         - name: vnf-id
38320           in: path
38321           description: Unique id of VNF.  This is unique across the graph.
38322           required: true
38323           type: string
38324           example: __VNF-ID__
38325         - name: interface-name
38326           in: path
38327           description: Name that identifies the link aggregate interface
38328           required: true
38329           type: string
38330           example: __INTERFACE-NAME__
38331         - name: interface-name
38332           in: path
38333           description: Name given to the interface
38334           required: true
38335           type: string
38336           example: __INTERFACE-NAME__
38337         - name: vlan-interface
38338           in: path
38339           description: String that identifies the interface
38340           required: true
38341           type: string
38342           example: __VLAN-INTERFACE__
38343         - name: l3-interface-ipv4-address
38344           in: path
38345           description: IP address
38346           required: true
38347           type: string
38348           example: __L3-INTERFACE-IPV4-ADDRESS__
38349         - name: body
38350           in: body
38351           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38352           required: true
38353           schema:
38354             $ref: "#/definitions/l3-interface-ipv4-address-list"
38355     patch:
38356       tags:
38357         - Network
38358       summary: update an existing l3-interface-ipv4-address-list
38359       description: |
38360         Update an existing l3-interface-ipv4-address-list
38361         #
38362         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38363         The PUT operation will entirely replace an existing object.
38364         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.
38365         #
38366         Other differences between PUT and PATCH are:
38367         #
38368         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38369         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38370         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38371       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38372       consumes:
38373         - application/json
38374         - application/xml
38375       produces:
38376         - application/json
38377         - application/xml
38378       responses:
38379         "default":
38380           description: Response codes found in [response codes](https://wiki.onap.org/).
38381       parameters:
38382         - name: vnf-id
38383           in: path
38384           description: Unique id of VNF.  This is unique across the graph.
38385           required: true
38386           type: string
38387           example: __VNF-ID__
38388         - name: interface-name
38389           in: path
38390           description: Name that identifies the link aggregate interface
38391           required: true
38392           type: string
38393           example: __INTERFACE-NAME__
38394         - name: interface-name
38395           in: path
38396           description: Name given to the interface
38397           required: true
38398           type: string
38399           example: __INTERFACE-NAME__
38400         - name: vlan-interface
38401           in: path
38402           description: String that identifies the interface
38403           required: true
38404           type: string
38405           example: __VLAN-INTERFACE__
38406         - name: l3-interface-ipv4-address
38407           in: path
38408           description: IP address
38409           required: true
38410           type: string
38411           example: __L3-INTERFACE-IPV4-ADDRESS__
38412         - name: body
38413           in: body
38414           description: l3-interface-ipv4-address-list object that needs to be created or updated.
38415           required: true
38416           schema:
38417             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38418     delete:
38419       tags:
38420         - Network
38421       summary: delete an existing l3-interface-ipv4-address-list
38422       description: delete an existing l3-interface-ipv4-address-list
38423       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38424       consumes:
38425         - application/json
38426         - application/xml
38427       produces:
38428         - application/json
38429         - application/xml
38430       responses:
38431         "default":
38432           description: Response codes found in [response codes](https://wiki.onap.org/).
38433       parameters:
38434         - name: vnf-id
38435           in: path
38436           description: Unique id of VNF.  This is unique across the graph.
38437           required: true
38438           type: string
38439           example: __VNF-ID__
38440         - name: interface-name
38441           in: path
38442           description: Name that identifies the link aggregate interface
38443           required: true
38444           type: string
38445           example: __INTERFACE-NAME__
38446         - name: interface-name
38447           in: path
38448           description: Name given to the interface
38449           required: true
38450           type: string
38451           example: __INTERFACE-NAME__
38452         - name: vlan-interface
38453           in: path
38454           description: String that identifies the interface
38455           required: true
38456           type: string
38457           example: __VLAN-INTERFACE__
38458         - name: l3-interface-ipv4-address
38459           in: path
38460           description: IP address
38461           required: true
38462           type: string
38463           example: __L3-INTERFACE-IPV4-ADDRESS__
38464         - name: resource-version
38465           in: query
38466           description: resource-version for concurrency
38467           required: true
38468           type: string
38469   /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:
38470     put:
38471       tags:
38472         - Network
38473       summary: see node definition for valid relationships
38474       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38475       consumes:
38476         - application/json
38477         - application/xml
38478       produces:
38479         - application/json
38480         - application/xml
38481       responses:
38482         "default":
38483           description: Response codes found in [response codes](https://wiki.onap.org/).
38484       parameters:
38485         - name: vnf-id
38486           in: path
38487           description: Unique id of VNF.  This is unique across the graph.
38488           required: true
38489           type: string
38490           example: __VNF-ID__
38491         - name: interface-name
38492           in: path
38493           description: Name that identifies the link aggregate interface
38494           required: true
38495           type: string
38496           example: __INTERFACE-NAME__
38497         - name: interface-name
38498           in: path
38499           description: Name given to the interface
38500           required: true
38501           type: string
38502           example: __INTERFACE-NAME__
38503         - name: vlan-interface
38504           in: path
38505           description: String that identifies the interface
38506           required: true
38507           type: string
38508           example: __VLAN-INTERFACE__
38509         - name: l3-interface-ipv6-address
38510           in: path
38511           description: IP address
38512           required: true
38513           type: string
38514           example: __L3-INTERFACE-IPV6-ADDRESS__
38515         - name: body
38516           in: body
38517           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38518           required: true
38519           schema:
38520             $ref: "#/definitions/relationship"
38521     delete:
38522       tags:
38523         - Network
38524       summary: delete an existing relationship
38525       description: delete an existing relationship
38526       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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-id
38538           in: path
38539           description: Unique id of VNF.  This is unique across the graph.
38540           required: true
38541           type: string
38542           example: __VNF-ID__
38543         - name: interface-name
38544           in: path
38545           description: Name that identifies the link aggregate interface
38546           required: true
38547           type: string
38548           example: __INTERFACE-NAME__
38549         - name: interface-name
38550           in: path
38551           description: Name given to the interface
38552           required: true
38553           type: string
38554           example: __INTERFACE-NAME__
38555         - name: vlan-interface
38556           in: path
38557           description: String that identifies the interface
38558           required: true
38559           type: string
38560           example: __VLAN-INTERFACE__
38561         - name: l3-interface-ipv6-address
38562           in: path
38563           description: IP address
38564           required: true
38565           type: string
38566           example: __L3-INTERFACE-IPV6-ADDRESS__
38567   /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}:
38568     get:
38569       tags:
38570         - Network
38571       summary: returns l3-interface-ipv6-address-list
38572       description: returns l3-interface-ipv6-address-list
38573       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38574       produces:
38575         - application/json
38576         - application/xml
38577       responses:
38578         "200":
38579           description: successful operation
38580           schema:
38581               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38582         "default":
38583           description: Response codes found in [response codes](https://wiki.onap.org/).
38584       parameters:
38585         - name: vnf-id
38586           in: path
38587           description: Unique id of VNF.  This is unique across the graph.
38588           required: true
38589           type: string
38590           example: __VNF-ID__
38591         - name: interface-name
38592           in: path
38593           description: Name that identifies the link aggregate interface
38594           required: true
38595           type: string
38596           example: __INTERFACE-NAME__
38597         - name: interface-name
38598           in: path
38599           description: Name given to the interface
38600           required: true
38601           type: string
38602           example: __INTERFACE-NAME__
38603         - name: vlan-interface
38604           in: path
38605           description: String that identifies the interface
38606           required: true
38607           type: string
38608           example: __VLAN-INTERFACE__
38609         - name: l3-interface-ipv6-address
38610           in: path
38611           description: IP address
38612           required: true
38613           type: string
38614           example: __L3-INTERFACE-IPV6-ADDRESS__
38615         - name: vnf-name
38616           in: query
38617           description: Name of VNF.
38618           required: false
38619           type: string
38620         - name: vnf-name2
38621           in: query
38622           description: Alternate name of VNF.
38623           required: false
38624           type: string
38625         - name: vnf-type
38626           in: query
38627           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.
38628           required: false
38629           type: string
38630         - name: service-id
38631           in: query
38632           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38633           required: false
38634           type: string
38635         - name: regional-resource-zone
38636           in: query
38637           description: Regional way of organizing pservers, source of truth should define values
38638           required: false
38639           type: string
38640         - name: prov-status
38641           in: query
38642           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38643           required: false
38644           type: string
38645         - name: heat-stack-id
38646           in: query
38647           description: Heat stack id corresponding to this instance, managed by MSO
38648           required: false
38649           type: string
38650         - name: in-maint
38651           in: query
38652           required: false
38653           type: boolean
38654         - name: is-closed-loop-disabled
38655           in: query
38656           required: false
38657           type: boolean
38658         - name: model-invariant-id
38659           in: query
38660           description: the ASDC model id for this resource or service model.
38661           required: false
38662           type: string
38663         - name: model-version-id
38664           in: query
38665           description: the ASDC model version for this resource or service model.
38666           required: false
38667           type: string
38668         - name: widget-model-id
38669           in: query
38670           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38671           required: false
38672           type: string
38673         - name: widget-model-version
38674           in: query
38675           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38676           required: false
38677           type: string
38678         - name: nf-type
38679           in: query
38680           description: Generic description of the type of NF
38681           required: false
38682           type: string
38683         - name: nf-function
38684           in: query
38685           description: English description of Network function that the specific VNF deployment is providing
38686           required: false
38687           type: string
38688         - name: nf-role
38689           in: query
38690           description: role in the network that this model will be providing
38691           required: false
38692           type: string
38693         - name: nf-naming-code
38694           in: query
38695           description: string assigned to this model used for naming purposes
38696           required: false
38697           type: string
38698         - name: interface-id
38699           in: query
38700           description: ID of interface
38701           required: false
38702           type: string
38703         - name: interface-role
38704           in: query
38705           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38706           required: false
38707           type: string
38708         - name: interface-id
38709           in: query
38710           description: ID of interface
38711           required: false
38712           type: string
38713         - name: macaddr
38714           in: query
38715           description: MAC address for the interface
38716           required: false
38717           type: string
38718         - name: network-name
38719           in: query
38720           description: Name of the network
38721           required: false
38722           type: string
38723         - name: vlan-id-inner
38724           in: query
38725           description: Inner VLAN tag
38726           required: false
38727           type: integer
38728           format: int64
38729         - name: vpn-key
38730           in: query
38731           description: This indicates the customers VPN ID associated with this vlan
38732           required: false
38733           type: string
38734         - name: vlan-id-inner
38735           in: query
38736           description: Inner VLAN tag
38737           required: false
38738           type: integer
38739           format: int64
38740         - name: neutron-network-id
38741           in: query
38742           description: Neutron network id of the interface that address belongs to
38743           required: false
38744           type: string
38745         - name: neutron-subnet-id
38746           in: query
38747           description: Neutron id of subnet that address belongs to
38748           required: false
38749           type: string
38750     put:
38751       tags:
38752         - Network
38753       summary: create or update an existing l3-interface-ipv6-address-list
38754       description: |
38755         Create or update an existing l3-interface-ipv6-address-list.
38756         #
38757         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
38758       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38759       consumes:
38760         - application/json
38761         - application/xml
38762       produces:
38763         - application/json
38764         - application/xml
38765       responses:
38766         "default":
38767           description: Response codes found in [response codes](https://wiki.onap.org/).
38768       parameters:
38769         - name: vnf-id
38770           in: path
38771           description: Unique id of VNF.  This is unique across the graph.
38772           required: true
38773           type: string
38774           example: __VNF-ID__
38775         - name: interface-name
38776           in: path
38777           description: Name that identifies the link aggregate interface
38778           required: true
38779           type: string
38780           example: __INTERFACE-NAME__
38781         - name: interface-name
38782           in: path
38783           description: Name given to the interface
38784           required: true
38785           type: string
38786           example: __INTERFACE-NAME__
38787         - name: vlan-interface
38788           in: path
38789           description: String that identifies the interface
38790           required: true
38791           type: string
38792           example: __VLAN-INTERFACE__
38793         - name: l3-interface-ipv6-address
38794           in: path
38795           description: IP address
38796           required: true
38797           type: string
38798           example: __L3-INTERFACE-IPV6-ADDRESS__
38799         - name: body
38800           in: body
38801           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38802           required: true
38803           schema:
38804             $ref: "#/definitions/l3-interface-ipv6-address-list"
38805     patch:
38806       tags:
38807         - Network
38808       summary: update an existing l3-interface-ipv6-address-list
38809       description: |
38810         Update an existing l3-interface-ipv6-address-list
38811         #
38812         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38813         The PUT operation will entirely replace an existing object.
38814         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.
38815         #
38816         Other differences between PUT and PATCH are:
38817         #
38818         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38819         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38820         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38821       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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-id
38833           in: path
38834           description: Unique id of VNF.  This is unique across the graph.
38835           required: true
38836           type: string
38837           example: __VNF-ID__
38838         - name: interface-name
38839           in: path
38840           description: Name that identifies the link aggregate interface
38841           required: true
38842           type: string
38843           example: __INTERFACE-NAME__
38844         - name: interface-name
38845           in: path
38846           description: Name given to the interface
38847           required: true
38848           type: string
38849           example: __INTERFACE-NAME__
38850         - name: vlan-interface
38851           in: path
38852           description: String that identifies the interface
38853           required: true
38854           type: string
38855           example: __VLAN-INTERFACE__
38856         - name: l3-interface-ipv6-address
38857           in: path
38858           description: IP address
38859           required: true
38860           type: string
38861           example: __L3-INTERFACE-IPV6-ADDRESS__
38862         - name: body
38863           in: body
38864           description: l3-interface-ipv6-address-list object that needs to be created or updated.
38865           required: true
38866           schema:
38867             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38868     delete:
38869       tags:
38870         - Network
38871       summary: delete an existing l3-interface-ipv6-address-list
38872       description: delete an existing l3-interface-ipv6-address-list
38873       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38874       consumes:
38875         - application/json
38876         - application/xml
38877       produces:
38878         - application/json
38879         - application/xml
38880       responses:
38881         "default":
38882           description: Response codes found in [response codes](https://wiki.onap.org/).
38883       parameters:
38884         - name: vnf-id
38885           in: path
38886           description: Unique id of VNF.  This is unique across the graph.
38887           required: true
38888           type: string
38889           example: __VNF-ID__
38890         - name: interface-name
38891           in: path
38892           description: Name that identifies the link aggregate interface
38893           required: true
38894           type: string
38895           example: __INTERFACE-NAME__
38896         - name: interface-name
38897           in: path
38898           description: Name given to the interface
38899           required: true
38900           type: string
38901           example: __INTERFACE-NAME__
38902         - name: vlan-interface
38903           in: path
38904           description: String that identifies the interface
38905           required: true
38906           type: string
38907           example: __VLAN-INTERFACE__
38908         - name: l3-interface-ipv6-address
38909           in: path
38910           description: IP address
38911           required: true
38912           type: string
38913           example: __L3-INTERFACE-IPV6-ADDRESS__
38914         - name: resource-version
38915           in: query
38916           description: resource-version for concurrency
38917           required: true
38918           type: string
38919   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38920     get:
38921       tags:
38922         - Network
38923       summary: returns vlan
38924       description: returns vlan
38925       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38926       produces:
38927         - application/json
38928         - application/xml
38929       responses:
38930         "200":
38931           description: successful operation
38932           schema:
38933               $ref: "#/getDefinitions/vlan"
38934         "default":
38935           description: Response codes found in [response codes](https://wiki.onap.org/).
38936       parameters:
38937         - name: vnf-id
38938           in: path
38939           description: Unique id of VNF.  This is unique across the graph.
38940           required: true
38941           type: string
38942           example: __VNF-ID__
38943         - name: interface-name
38944           in: path
38945           description: Name that identifies the link aggregate interface
38946           required: true
38947           type: string
38948           example: __INTERFACE-NAME__
38949         - name: interface-name
38950           in: path
38951           description: Name given to the interface
38952           required: true
38953           type: string
38954           example: __INTERFACE-NAME__
38955         - name: vlan-interface
38956           in: path
38957           description: String that identifies the interface
38958           required: true
38959           type: string
38960           example: __VLAN-INTERFACE__
38961         - name: vnf-name
38962           in: query
38963           description: Name of VNF.
38964           required: false
38965           type: string
38966         - name: vnf-name2
38967           in: query
38968           description: Alternate name of VNF.
38969           required: false
38970           type: string
38971         - name: vnf-type
38972           in: query
38973           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.
38974           required: false
38975           type: string
38976         - name: service-id
38977           in: query
38978           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38979           required: false
38980           type: string
38981         - name: regional-resource-zone
38982           in: query
38983           description: Regional way of organizing pservers, source of truth should define values
38984           required: false
38985           type: string
38986         - name: prov-status
38987           in: query
38988           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38989           required: false
38990           type: string
38991         - name: heat-stack-id
38992           in: query
38993           description: Heat stack id corresponding to this instance, managed by MSO
38994           required: false
38995           type: string
38996         - name: in-maint
38997           in: query
38998           required: false
38999           type: boolean
39000         - name: is-closed-loop-disabled
39001           in: query
39002           required: false
39003           type: boolean
39004         - name: model-invariant-id
39005           in: query
39006           description: the ASDC model id for this resource or service model.
39007           required: false
39008           type: string
39009         - name: model-version-id
39010           in: query
39011           description: the ASDC model version for this resource or service model.
39012           required: false
39013           type: string
39014         - name: widget-model-id
39015           in: query
39016           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39017           required: false
39018           type: string
39019         - name: widget-model-version
39020           in: query
39021           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39022           required: false
39023           type: string
39024         - name: nf-type
39025           in: query
39026           description: Generic description of the type of NF
39027           required: false
39028           type: string
39029         - name: nf-function
39030           in: query
39031           description: English description of Network function that the specific VNF deployment is providing
39032           required: false
39033           type: string
39034         - name: nf-role
39035           in: query
39036           description: role in the network that this model will be providing
39037           required: false
39038           type: string
39039         - name: nf-naming-code
39040           in: query
39041           description: string assigned to this model used for naming purposes
39042           required: false
39043           type: string
39044         - name: interface-id
39045           in: query
39046           description: ID of interface
39047           required: false
39048           type: string
39049         - name: interface-role
39050           in: query
39051           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39052           required: false
39053           type: string
39054         - name: interface-id
39055           in: query
39056           description: ID of interface
39057           required: false
39058           type: string
39059         - name: macaddr
39060           in: query
39061           description: MAC address for the interface
39062           required: false
39063           type: string
39064         - name: network-name
39065           in: query
39066           description: Name of the network
39067           required: false
39068           type: string
39069         - name: vlan-id-inner
39070           in: query
39071           description: Inner VLAN tag
39072           required: false
39073           type: integer
39074           format: int64
39075         - name: vpn-key
39076           in: query
39077           description: This indicates the customers VPN ID associated with this vlan
39078           required: false
39079           type: string
39080     put:
39081       tags:
39082         - Network
39083       summary: create or update an existing vlan
39084       description: |
39085         Create or update an existing vlan.
39086         #
39087         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
39088       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39089       consumes:
39090         - application/json
39091         - application/xml
39092       produces:
39093         - application/json
39094         - application/xml
39095       responses:
39096         "default":
39097           description: Response codes found in [response codes](https://wiki.onap.org/).
39098       parameters:
39099         - name: vnf-id
39100           in: path
39101           description: Unique id of VNF.  This is unique across the graph.
39102           required: true
39103           type: string
39104           example: __VNF-ID__
39105         - name: interface-name
39106           in: path
39107           description: Name that identifies the link aggregate interface
39108           required: true
39109           type: string
39110           example: __INTERFACE-NAME__
39111         - name: interface-name
39112           in: path
39113           description: Name given to the interface
39114           required: true
39115           type: string
39116           example: __INTERFACE-NAME__
39117         - name: vlan-interface
39118           in: path
39119           description: String that identifies the interface
39120           required: true
39121           type: string
39122           example: __VLAN-INTERFACE__
39123         - name: body
39124           in: body
39125           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
39126           required: true
39127           schema:
39128             $ref: "#/definitions/vlan"
39129     patch:
39130       tags:
39131         - Network
39132       summary: update an existing vlan
39133       description: |
39134         Update an existing vlan
39135         #
39136         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39137         The PUT operation will entirely replace an existing object.
39138         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.
39139         #
39140         Other differences between PUT and PATCH are:
39141         #
39142         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39143         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39144         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39145       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39146       consumes:
39147         - application/json
39148         - application/xml
39149       produces:
39150         - application/json
39151         - application/xml
39152       responses:
39153         "default":
39154           description: Response codes found in [response codes](https://wiki.onap.org/).
39155       parameters:
39156         - name: vnf-id
39157           in: path
39158           description: Unique id of VNF.  This is unique across the graph.
39159           required: true
39160           type: string
39161           example: __VNF-ID__
39162         - name: interface-name
39163           in: path
39164           description: Name that identifies the link aggregate interface
39165           required: true
39166           type: string
39167           example: __INTERFACE-NAME__
39168         - name: interface-name
39169           in: path
39170           description: Name given to the interface
39171           required: true
39172           type: string
39173           example: __INTERFACE-NAME__
39174         - name: vlan-interface
39175           in: path
39176           description: String that identifies the interface
39177           required: true
39178           type: string
39179           example: __VLAN-INTERFACE__
39180         - name: body
39181           in: body
39182           description: vlan object that needs to be created or updated.
39183           required: true
39184           schema:
39185             $ref: "#/patchDefinitions/vlan"
39186     delete:
39187       tags:
39188         - Network
39189       summary: delete an existing vlan
39190       description: delete an existing vlan
39191       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
39192       consumes:
39193         - application/json
39194         - application/xml
39195       produces:
39196         - application/json
39197         - application/xml
39198       responses:
39199         "default":
39200           description: Response codes found in [response codes](https://wiki.onap.org/).
39201       parameters:
39202         - name: vnf-id
39203           in: path
39204           description: Unique id of VNF.  This is unique across the graph.
39205           required: true
39206           type: string
39207           example: __VNF-ID__
39208         - name: interface-name
39209           in: path
39210           description: Name that identifies the link aggregate interface
39211           required: true
39212           type: string
39213           example: __INTERFACE-NAME__
39214         - name: interface-name
39215           in: path
39216           description: Name given to the interface
39217           required: true
39218           type: string
39219           example: __INTERFACE-NAME__
39220         - name: vlan-interface
39221           in: path
39222           description: String that identifies the interface
39223           required: true
39224           type: string
39225           example: __VLAN-INTERFACE__
39226         - name: resource-version
39227           in: query
39228           description: resource-version for concurrency
39229           required: true
39230           type: string
39231   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
39232     get:
39233       tags:
39234         - Network
39235       summary: returns vlans
39236       description: returns vlans
39237       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
39238       produces:
39239         - application/json
39240         - application/xml
39241       responses:
39242         "200":
39243           description: successful operation
39244           schema:
39245               $ref: "#/getDefinitions/vlans"
39246         "default":
39247           description: Response codes found in [response codes](https://wiki.onap.org/).
39248       parameters:
39249         - name: vnf-id
39250           in: path
39251           description: Unique id of VNF.  This is unique across the graph.
39252           required: true
39253           type: string
39254           example: __VNF-ID__
39255         - name: interface-name
39256           in: path
39257           description: Name that identifies the link aggregate interface
39258           required: true
39259           type: string
39260           example: __INTERFACE-NAME__
39261         - name: interface-name
39262           in: path
39263           description: Name given to the interface
39264           required: true
39265           type: string
39266           example: __INTERFACE-NAME__
39267         - name: vnf-name
39268           in: query
39269           description: Name of VNF.
39270           required: false
39271           type: string
39272         - name: vnf-name2
39273           in: query
39274           description: Alternate name of VNF.
39275           required: false
39276           type: string
39277         - name: vnf-type
39278           in: query
39279           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.
39280           required: false
39281           type: string
39282         - name: service-id
39283           in: query
39284           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39285           required: false
39286           type: string
39287         - name: regional-resource-zone
39288           in: query
39289           description: Regional way of organizing pservers, source of truth should define values
39290           required: false
39291           type: string
39292         - name: prov-status
39293           in: query
39294           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39295           required: false
39296           type: string
39297         - name: heat-stack-id
39298           in: query
39299           description: Heat stack id corresponding to this instance, managed by MSO
39300           required: false
39301           type: string
39302         - name: in-maint
39303           in: query
39304           required: false
39305           type: boolean
39306         - name: is-closed-loop-disabled
39307           in: query
39308           required: false
39309           type: boolean
39310         - name: model-invariant-id
39311           in: query
39312           description: the ASDC model id for this resource or service model.
39313           required: false
39314           type: string
39315         - name: model-version-id
39316           in: query
39317           description: the ASDC model version for this resource or service model.
39318           required: false
39319           type: string
39320         - name: widget-model-id
39321           in: query
39322           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39323           required: false
39324           type: string
39325         - name: widget-model-version
39326           in: query
39327           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39328           required: false
39329           type: string
39330         - name: nf-type
39331           in: query
39332           description: Generic description of the type of NF
39333           required: false
39334           type: string
39335         - name: nf-function
39336           in: query
39337           description: English description of Network function that the specific VNF deployment is providing
39338           required: false
39339           type: string
39340         - name: nf-role
39341           in: query
39342           description: role in the network that this model will be providing
39343           required: false
39344           type: string
39345         - name: nf-naming-code
39346           in: query
39347           description: string assigned to this model used for naming purposes
39348           required: false
39349           type: string
39350         - name: interface-id
39351           in: query
39352           description: ID of interface
39353           required: false
39354           type: string
39355         - name: interface-role
39356           in: query
39357           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39358           required: false
39359           type: string
39360         - name: interface-id
39361           in: query
39362           description: ID of interface
39363           required: false
39364           type: string
39365         - name: macaddr
39366           in: query
39367           description: MAC address for the interface
39368           required: false
39369           type: string
39370         - name: network-name
39371           in: query
39372           description: Name of the network
39373           required: false
39374           type: string
39375   /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:
39376     put:
39377       tags:
39378         - Network
39379       summary: see node definition for valid relationships
39380       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39381       consumes:
39382         - application/json
39383         - application/xml
39384       produces:
39385         - application/json
39386         - application/xml
39387       responses:
39388         "default":
39389           description: Response codes found in [response codes](https://wiki.onap.org/).
39390       parameters:
39391         - name: vnf-id
39392           in: path
39393           description: Unique id of VNF.  This is unique across the graph.
39394           required: true
39395           type: string
39396           example: __VNF-ID__
39397         - name: interface-name
39398           in: path
39399           description: Name that identifies the link aggregate interface
39400           required: true
39401           type: string
39402           example: __INTERFACE-NAME__
39403         - name: interface-name
39404           in: path
39405           description: Name given to the interface
39406           required: true
39407           type: string
39408           example: __INTERFACE-NAME__
39409         - name: pci-id
39410           in: path
39411           description: PCI ID used to identify the sriov-vf
39412           required: true
39413           type: string
39414           example: __PCI-ID__
39415         - name: body
39416           in: body
39417           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39418           required: true
39419           schema:
39420             $ref: "#/definitions/relationship"
39421     delete:
39422       tags:
39423         - Network
39424       summary: delete an existing relationship
39425       description: delete an existing relationship
39426       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39427       consumes:
39428         - application/json
39429         - application/xml
39430       produces:
39431         - application/json
39432         - application/xml
39433       responses:
39434         "default":
39435           description: Response codes found in [response codes](https://wiki.onap.org/).
39436       parameters:
39437         - name: vnf-id
39438           in: path
39439           description: Unique id of VNF.  This is unique across the graph.
39440           required: true
39441           type: string
39442           example: __VNF-ID__
39443         - name: interface-name
39444           in: path
39445           description: Name that identifies the link aggregate interface
39446           required: true
39447           type: string
39448           example: __INTERFACE-NAME__
39449         - name: interface-name
39450           in: path
39451           description: Name given to the interface
39452           required: true
39453           type: string
39454           example: __INTERFACE-NAME__
39455         - name: pci-id
39456           in: path
39457           description: PCI ID used to identify the sriov-vf
39458           required: true
39459           type: string
39460           example: __PCI-ID__
39461   /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}:
39462     get:
39463       tags:
39464         - Network
39465       summary: returns sriov-vf
39466       description: returns sriov-vf
39467       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39468       produces:
39469         - application/json
39470         - application/xml
39471       responses:
39472         "200":
39473           description: successful operation
39474           schema:
39475               $ref: "#/getDefinitions/sriov-vf"
39476         "default":
39477           description: Response codes found in [response codes](https://wiki.onap.org/).
39478       parameters:
39479         - name: vnf-id
39480           in: path
39481           description: Unique id of VNF.  This is unique across the graph.
39482           required: true
39483           type: string
39484           example: __VNF-ID__
39485         - name: interface-name
39486           in: path
39487           description: Name that identifies the link aggregate interface
39488           required: true
39489           type: string
39490           example: __INTERFACE-NAME__
39491         - name: interface-name
39492           in: path
39493           description: Name given to the interface
39494           required: true
39495           type: string
39496           example: __INTERFACE-NAME__
39497         - name: pci-id
39498           in: path
39499           description: PCI ID used to identify the sriov-vf
39500           required: true
39501           type: string
39502           example: __PCI-ID__
39503         - name: vnf-name
39504           in: query
39505           description: Name of VNF.
39506           required: false
39507           type: string
39508         - name: vnf-name2
39509           in: query
39510           description: Alternate name of VNF.
39511           required: false
39512           type: string
39513         - name: vnf-type
39514           in: query
39515           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.
39516           required: false
39517           type: string
39518         - name: service-id
39519           in: query
39520           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39521           required: false
39522           type: string
39523         - name: regional-resource-zone
39524           in: query
39525           description: Regional way of organizing pservers, source of truth should define values
39526           required: false
39527           type: string
39528         - name: prov-status
39529           in: query
39530           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39531           required: false
39532           type: string
39533         - name: heat-stack-id
39534           in: query
39535           description: Heat stack id corresponding to this instance, managed by MSO
39536           required: false
39537           type: string
39538         - name: in-maint
39539           in: query
39540           required: false
39541           type: boolean
39542         - name: is-closed-loop-disabled
39543           in: query
39544           required: false
39545           type: boolean
39546         - name: model-invariant-id
39547           in: query
39548           description: the ASDC model id for this resource or service model.
39549           required: false
39550           type: string
39551         - name: model-version-id
39552           in: query
39553           description: the ASDC model version for this resource or service model.
39554           required: false
39555           type: string
39556         - name: widget-model-id
39557           in: query
39558           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39559           required: false
39560           type: string
39561         - name: widget-model-version
39562           in: query
39563           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39564           required: false
39565           type: string
39566         - name: nf-type
39567           in: query
39568           description: Generic description of the type of NF
39569           required: false
39570           type: string
39571         - name: nf-function
39572           in: query
39573           description: English description of Network function that the specific VNF deployment is providing
39574           required: false
39575           type: string
39576         - name: nf-role
39577           in: query
39578           description: role in the network that this model will be providing
39579           required: false
39580           type: string
39581         - name: nf-naming-code
39582           in: query
39583           description: string assigned to this model used for naming purposes
39584           required: false
39585           type: string
39586         - name: interface-id
39587           in: query
39588           description: ID of interface
39589           required: false
39590           type: string
39591         - name: interface-role
39592           in: query
39593           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39594           required: false
39595           type: string
39596         - name: interface-id
39597           in: query
39598           description: ID of interface
39599           required: false
39600           type: string
39601         - name: macaddr
39602           in: query
39603           description: MAC address for the interface
39604           required: false
39605           type: string
39606         - name: network-name
39607           in: query
39608           description: Name of the network
39609           required: false
39610           type: string
39611         - name: vf-vlan-filter
39612           in: query
39613           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
39614           required: false
39615           type: string
39616         - name: vf-mac-filter
39617           in: query
39618           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
39619           required: false
39620           type: string
39621         - name: vf-vlan-strip
39622           in: query
39623           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
39624           required: false
39625           type: boolean
39626         - name: neutron-network-id
39627           in: query
39628           description: Neutron network id of the interface
39629           required: false
39630           type: string
39631     put:
39632       tags:
39633         - Network
39634       summary: create or update an existing sriov-vf
39635       description: |
39636         Create or update an existing sriov-vf.
39637         #
39638         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
39639       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39640       consumes:
39641         - application/json
39642         - application/xml
39643       produces:
39644         - application/json
39645         - application/xml
39646       responses:
39647         "default":
39648           description: Response codes found in [response codes](https://wiki.onap.org/).
39649       parameters:
39650         - name: vnf-id
39651           in: path
39652           description: Unique id of VNF.  This is unique across the graph.
39653           required: true
39654           type: string
39655           example: __VNF-ID__
39656         - name: interface-name
39657           in: path
39658           description: Name that identifies the link aggregate interface
39659           required: true
39660           type: string
39661           example: __INTERFACE-NAME__
39662         - name: interface-name
39663           in: path
39664           description: Name given to the interface
39665           required: true
39666           type: string
39667           example: __INTERFACE-NAME__
39668         - name: pci-id
39669           in: path
39670           description: PCI ID used to identify the sriov-vf
39671           required: true
39672           type: string
39673           example: __PCI-ID__
39674         - name: body
39675           in: body
39676           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
39677           required: true
39678           schema:
39679             $ref: "#/definitions/sriov-vf"
39680     patch:
39681       tags:
39682         - Network
39683       summary: update an existing sriov-vf
39684       description: |
39685         Update an existing sriov-vf
39686         #
39687         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39688         The PUT operation will entirely replace an existing object.
39689         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.
39690         #
39691         Other differences between PUT and PATCH are:
39692         #
39693         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39694         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39695         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39696       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39697       consumes:
39698         - application/json
39699         - application/xml
39700       produces:
39701         - application/json
39702         - application/xml
39703       responses:
39704         "default":
39705           description: Response codes found in [response codes](https://wiki.onap.org/).
39706       parameters:
39707         - name: vnf-id
39708           in: path
39709           description: Unique id of VNF.  This is unique across the graph.
39710           required: true
39711           type: string
39712           example: __VNF-ID__
39713         - name: interface-name
39714           in: path
39715           description: Name that identifies the link aggregate interface
39716           required: true
39717           type: string
39718           example: __INTERFACE-NAME__
39719         - name: interface-name
39720           in: path
39721           description: Name given to the interface
39722           required: true
39723           type: string
39724           example: __INTERFACE-NAME__
39725         - name: pci-id
39726           in: path
39727           description: PCI ID used to identify the sriov-vf
39728           required: true
39729           type: string
39730           example: __PCI-ID__
39731         - name: body
39732           in: body
39733           description: sriov-vf object that needs to be created or updated.
39734           required: true
39735           schema:
39736             $ref: "#/patchDefinitions/sriov-vf"
39737     delete:
39738       tags:
39739         - Network
39740       summary: delete an existing sriov-vf
39741       description: delete an existing sriov-vf
39742       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
39743       consumes:
39744         - application/json
39745         - application/xml
39746       produces:
39747         - application/json
39748         - application/xml
39749       responses:
39750         "default":
39751           description: Response codes found in [response codes](https://wiki.onap.org/).
39752       parameters:
39753         - name: vnf-id
39754           in: path
39755           description: Unique id of VNF.  This is unique across the graph.
39756           required: true
39757           type: string
39758           example: __VNF-ID__
39759         - name: interface-name
39760           in: path
39761           description: Name that identifies the link aggregate interface
39762           required: true
39763           type: string
39764           example: __INTERFACE-NAME__
39765         - name: interface-name
39766           in: path
39767           description: Name given to the interface
39768           required: true
39769           type: string
39770           example: __INTERFACE-NAME__
39771         - name: pci-id
39772           in: path
39773           description: PCI ID used to identify the sriov-vf
39774           required: true
39775           type: string
39776           example: __PCI-ID__
39777         - name: resource-version
39778           in: query
39779           description: resource-version for concurrency
39780           required: true
39781           type: string
39782   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
39783     get:
39784       tags:
39785         - Network
39786       summary: returns sriov-vfs
39787       description: returns sriov-vfs
39788       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
39789       produces:
39790         - application/json
39791         - application/xml
39792       responses:
39793         "200":
39794           description: successful operation
39795           schema:
39796               $ref: "#/getDefinitions/sriov-vfs"
39797         "default":
39798           description: Response codes found in [response codes](https://wiki.onap.org/).
39799       parameters:
39800         - name: vnf-id
39801           in: path
39802           description: Unique id of VNF.  This is unique across the graph.
39803           required: true
39804           type: string
39805           example: __VNF-ID__
39806         - name: interface-name
39807           in: path
39808           description: Name that identifies the link aggregate interface
39809           required: true
39810           type: string
39811           example: __INTERFACE-NAME__
39812         - name: interface-name
39813           in: path
39814           description: Name given to the interface
39815           required: true
39816           type: string
39817           example: __INTERFACE-NAME__
39818         - name: vnf-name
39819           in: query
39820           description: Name of VNF.
39821           required: false
39822           type: string
39823         - name: vnf-name2
39824           in: query
39825           description: Alternate name of VNF.
39826           required: false
39827           type: string
39828         - name: vnf-type
39829           in: query
39830           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.
39831           required: false
39832           type: string
39833         - name: service-id
39834           in: query
39835           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39836           required: false
39837           type: string
39838         - name: regional-resource-zone
39839           in: query
39840           description: Regional way of organizing pservers, source of truth should define values
39841           required: false
39842           type: string
39843         - name: prov-status
39844           in: query
39845           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39846           required: false
39847           type: string
39848         - name: heat-stack-id
39849           in: query
39850           description: Heat stack id corresponding to this instance, managed by MSO
39851           required: false
39852           type: string
39853         - name: in-maint
39854           in: query
39855           required: false
39856           type: boolean
39857         - name: is-closed-loop-disabled
39858           in: query
39859           required: false
39860           type: boolean
39861         - name: model-invariant-id
39862           in: query
39863           description: the ASDC model id for this resource or service model.
39864           required: false
39865           type: string
39866         - name: model-version-id
39867           in: query
39868           description: the ASDC model version for this resource or service model.
39869           required: false
39870           type: string
39871         - name: widget-model-id
39872           in: query
39873           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39874           required: false
39875           type: string
39876         - name: widget-model-version
39877           in: query
39878           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39879           required: false
39880           type: string
39881         - name: nf-type
39882           in: query
39883           description: Generic description of the type of NF
39884           required: false
39885           type: string
39886         - name: nf-function
39887           in: query
39888           description: English description of Network function that the specific VNF deployment is providing
39889           required: false
39890           type: string
39891         - name: nf-role
39892           in: query
39893           description: role in the network that this model will be providing
39894           required: false
39895           type: string
39896         - name: nf-naming-code
39897           in: query
39898           description: string assigned to this model used for naming purposes
39899           required: false
39900           type: string
39901         - name: interface-id
39902           in: query
39903           description: ID of interface
39904           required: false
39905           type: string
39906         - name: interface-role
39907           in: query
39908           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39909           required: false
39910           type: string
39911         - name: interface-id
39912           in: query
39913           description: ID of interface
39914           required: false
39915           type: string
39916         - name: macaddr
39917           in: query
39918           description: MAC address for the interface
39919           required: false
39920           type: string
39921         - name: network-name
39922           in: query
39923           description: Name of the network
39924           required: false
39925           type: string
39926   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39927     put:
39928       tags:
39929         - Network
39930       summary: see node definition for valid relationships
39931       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
39932       consumes:
39933         - application/json
39934         - application/xml
39935       produces:
39936         - application/json
39937         - application/xml
39938       responses:
39939         "default":
39940           description: Response codes found in [response codes](https://wiki.onap.org/).
39941       parameters:
39942         - name: vnf-id
39943           in: path
39944           description: Unique id of VNF.  This is unique across the graph.
39945           required: true
39946           type: string
39947           example: __VNF-ID__
39948         - name: interface-name
39949           in: path
39950           description: Name that identifies the link aggregate interface
39951           required: true
39952           type: string
39953           example: __INTERFACE-NAME__
39954         - name: interface-name
39955           in: path
39956           description: Name given to the interface
39957           required: true
39958           type: string
39959           example: __INTERFACE-NAME__
39960         - name: body
39961           in: body
39962           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39963           required: true
39964           schema:
39965             $ref: "#/definitions/relationship"
39966     delete:
39967       tags:
39968         - Network
39969       summary: delete an existing relationship
39970       description: delete an existing relationship
39971       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
39972       consumes:
39973         - application/json
39974         - application/xml
39975       produces:
39976         - application/json
39977         - application/xml
39978       responses:
39979         "default":
39980           description: Response codes found in [response codes](https://wiki.onap.org/).
39981       parameters:
39982         - name: vnf-id
39983           in: path
39984           description: Unique id of VNF.  This is unique across the graph.
39985           required: true
39986           type: string
39987           example: __VNF-ID__
39988         - name: interface-name
39989           in: path
39990           description: Name that identifies the link aggregate interface
39991           required: true
39992           type: string
39993           example: __INTERFACE-NAME__
39994         - name: interface-name
39995           in: path
39996           description: Name given to the interface
39997           required: true
39998           type: string
39999           example: __INTERFACE-NAME__
40000   /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:
40001     put:
40002       tags:
40003         - Network
40004       summary: see node definition for valid relationships
40005       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40006       consumes:
40007         - application/json
40008         - application/xml
40009       produces:
40010         - application/json
40011         - application/xml
40012       responses:
40013         "default":
40014           description: Response codes found in [response codes](https://wiki.onap.org/).
40015       parameters:
40016         - name: vnf-id
40017           in: path
40018           description: Unique id of VNF.  This is unique across the graph.
40019           required: true
40020           type: string
40021           example: __VNF-ID__
40022         - name: interface-name
40023           in: path
40024           description: Name that identifies the link aggregate interface
40025           required: true
40026           type: string
40027           example: __INTERFACE-NAME__
40028         - name: interface-name
40029           in: path
40030           description: Name given to the interface
40031           required: true
40032           type: string
40033           example: __INTERFACE-NAME__
40034         - name: l3-interface-ipv4-address
40035           in: path
40036           description: IP address
40037           required: true
40038           type: string
40039           example: __L3-INTERFACE-IPV4-ADDRESS__
40040         - name: body
40041           in: body
40042           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40043           required: true
40044           schema:
40045             $ref: "#/definitions/relationship"
40046     delete:
40047       tags:
40048         - Network
40049       summary: delete an existing relationship
40050       description: delete an existing relationship
40051       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40052       consumes:
40053         - application/json
40054         - application/xml
40055       produces:
40056         - application/json
40057         - application/xml
40058       responses:
40059         "default":
40060           description: Response codes found in [response codes](https://wiki.onap.org/).
40061       parameters:
40062         - name: vnf-id
40063           in: path
40064           description: Unique id of VNF.  This is unique across the graph.
40065           required: true
40066           type: string
40067           example: __VNF-ID__
40068         - name: interface-name
40069           in: path
40070           description: Name that identifies the link aggregate interface
40071           required: true
40072           type: string
40073           example: __INTERFACE-NAME__
40074         - name: interface-name
40075           in: path
40076           description: Name given to the interface
40077           required: true
40078           type: string
40079           example: __INTERFACE-NAME__
40080         - name: l3-interface-ipv4-address
40081           in: path
40082           description: IP address
40083           required: true
40084           type: string
40085           example: __L3-INTERFACE-IPV4-ADDRESS__
40086   /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}:
40087     get:
40088       tags:
40089         - Network
40090       summary: returns l3-interface-ipv4-address-list
40091       description: returns l3-interface-ipv4-address-list
40092       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40093       produces:
40094         - application/json
40095         - application/xml
40096       responses:
40097         "200":
40098           description: successful operation
40099           schema:
40100               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40101         "default":
40102           description: Response codes found in [response codes](https://wiki.onap.org/).
40103       parameters:
40104         - name: vnf-id
40105           in: path
40106           description: Unique id of VNF.  This is unique across the graph.
40107           required: true
40108           type: string
40109           example: __VNF-ID__
40110         - name: interface-name
40111           in: path
40112           description: Name that identifies the link aggregate interface
40113           required: true
40114           type: string
40115           example: __INTERFACE-NAME__
40116         - name: interface-name
40117           in: path
40118           description: Name given to the interface
40119           required: true
40120           type: string
40121           example: __INTERFACE-NAME__
40122         - name: l3-interface-ipv4-address
40123           in: path
40124           description: IP address
40125           required: true
40126           type: string
40127           example: __L3-INTERFACE-IPV4-ADDRESS__
40128         - name: vnf-name
40129           in: query
40130           description: Name of VNF.
40131           required: false
40132           type: string
40133         - name: vnf-name2
40134           in: query
40135           description: Alternate name of VNF.
40136           required: false
40137           type: string
40138         - name: vnf-type
40139           in: query
40140           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.
40141           required: false
40142           type: string
40143         - name: service-id
40144           in: query
40145           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40146           required: false
40147           type: string
40148         - name: regional-resource-zone
40149           in: query
40150           description: Regional way of organizing pservers, source of truth should define values
40151           required: false
40152           type: string
40153         - name: prov-status
40154           in: query
40155           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40156           required: false
40157           type: string
40158         - name: heat-stack-id
40159           in: query
40160           description: Heat stack id corresponding to this instance, managed by MSO
40161           required: false
40162           type: string
40163         - name: in-maint
40164           in: query
40165           required: false
40166           type: boolean
40167         - name: is-closed-loop-disabled
40168           in: query
40169           required: false
40170           type: boolean
40171         - name: model-invariant-id
40172           in: query
40173           description: the ASDC model id for this resource or service model.
40174           required: false
40175           type: string
40176         - name: model-version-id
40177           in: query
40178           description: the ASDC model version for this resource or service model.
40179           required: false
40180           type: string
40181         - name: widget-model-id
40182           in: query
40183           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40184           required: false
40185           type: string
40186         - name: widget-model-version
40187           in: query
40188           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40189           required: false
40190           type: string
40191         - name: nf-type
40192           in: query
40193           description: Generic description of the type of NF
40194           required: false
40195           type: string
40196         - name: nf-function
40197           in: query
40198           description: English description of Network function that the specific VNF deployment is providing
40199           required: false
40200           type: string
40201         - name: nf-role
40202           in: query
40203           description: role in the network that this model will be providing
40204           required: false
40205           type: string
40206         - name: nf-naming-code
40207           in: query
40208           description: string assigned to this model used for naming purposes
40209           required: false
40210           type: string
40211         - name: interface-id
40212           in: query
40213           description: ID of interface
40214           required: false
40215           type: string
40216         - name: interface-role
40217           in: query
40218           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40219           required: false
40220           type: string
40221         - name: interface-id
40222           in: query
40223           description: ID of interface
40224           required: false
40225           type: string
40226         - name: macaddr
40227           in: query
40228           description: MAC address for the interface
40229           required: false
40230           type: string
40231         - name: network-name
40232           in: query
40233           description: Name of the network
40234           required: false
40235           type: string
40236         - name: vlan-id-inner
40237           in: query
40238           description: Inner VLAN tag
40239           required: false
40240           type: integer
40241           format: int64
40242         - name: neutron-network-id
40243           in: query
40244           description: Neutron network id of the interface that address belongs to
40245           required: false
40246           type: string
40247         - name: neutron-subnet-id
40248           in: query
40249           description: Neutron id of subnet that address belongs to
40250           required: false
40251           type: string
40252     put:
40253       tags:
40254         - Network
40255       summary: create or update an existing l3-interface-ipv4-address-list
40256       description: |
40257         Create or update an existing l3-interface-ipv4-address-list.
40258         #
40259         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
40260       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40261       consumes:
40262         - application/json
40263         - application/xml
40264       produces:
40265         - application/json
40266         - application/xml
40267       responses:
40268         "default":
40269           description: Response codes found in [response codes](https://wiki.onap.org/).
40270       parameters:
40271         - name: vnf-id
40272           in: path
40273           description: Unique id of VNF.  This is unique across the graph.
40274           required: true
40275           type: string
40276           example: __VNF-ID__
40277         - name: interface-name
40278           in: path
40279           description: Name that identifies the link aggregate interface
40280           required: true
40281           type: string
40282           example: __INTERFACE-NAME__
40283         - name: interface-name
40284           in: path
40285           description: Name given to the interface
40286           required: true
40287           type: string
40288           example: __INTERFACE-NAME__
40289         - name: l3-interface-ipv4-address
40290           in: path
40291           description: IP address
40292           required: true
40293           type: string
40294           example: __L3-INTERFACE-IPV4-ADDRESS__
40295         - name: body
40296           in: body
40297           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40298           required: true
40299           schema:
40300             $ref: "#/definitions/l3-interface-ipv4-address-list"
40301     patch:
40302       tags:
40303         - Network
40304       summary: update an existing l3-interface-ipv4-address-list
40305       description: |
40306         Update an existing l3-interface-ipv4-address-list
40307         #
40308         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40309         The PUT operation will entirely replace an existing object.
40310         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.
40311         #
40312         Other differences between PUT and PATCH are:
40313         #
40314         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40315         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40316         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40317       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40318       consumes:
40319         - application/json
40320         - application/xml
40321       produces:
40322         - application/json
40323         - application/xml
40324       responses:
40325         "default":
40326           description: Response codes found in [response codes](https://wiki.onap.org/).
40327       parameters:
40328         - name: vnf-id
40329           in: path
40330           description: Unique id of VNF.  This is unique across the graph.
40331           required: true
40332           type: string
40333           example: __VNF-ID__
40334         - name: interface-name
40335           in: path
40336           description: Name that identifies the link aggregate interface
40337           required: true
40338           type: string
40339           example: __INTERFACE-NAME__
40340         - name: interface-name
40341           in: path
40342           description: Name given to the interface
40343           required: true
40344           type: string
40345           example: __INTERFACE-NAME__
40346         - name: l3-interface-ipv4-address
40347           in: path
40348           description: IP address
40349           required: true
40350           type: string
40351           example: __L3-INTERFACE-IPV4-ADDRESS__
40352         - name: body
40353           in: body
40354           description: l3-interface-ipv4-address-list object that needs to be created or updated.
40355           required: true
40356           schema:
40357             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40358     delete:
40359       tags:
40360         - Network
40361       summary: delete an existing l3-interface-ipv4-address-list
40362       description: delete an existing l3-interface-ipv4-address-list
40363       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40364       consumes:
40365         - application/json
40366         - application/xml
40367       produces:
40368         - application/json
40369         - application/xml
40370       responses:
40371         "default":
40372           description: Response codes found in [response codes](https://wiki.onap.org/).
40373       parameters:
40374         - name: vnf-id
40375           in: path
40376           description: Unique id of VNF.  This is unique across the graph.
40377           required: true
40378           type: string
40379           example: __VNF-ID__
40380         - name: interface-name
40381           in: path
40382           description: Name that identifies the link aggregate interface
40383           required: true
40384           type: string
40385           example: __INTERFACE-NAME__
40386         - name: interface-name
40387           in: path
40388           description: Name given to the interface
40389           required: true
40390           type: string
40391           example: __INTERFACE-NAME__
40392         - name: l3-interface-ipv4-address
40393           in: path
40394           description: IP address
40395           required: true
40396           type: string
40397           example: __L3-INTERFACE-IPV4-ADDRESS__
40398         - name: resource-version
40399           in: query
40400           description: resource-version for concurrency
40401           required: true
40402           type: string
40403   /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:
40404     put:
40405       tags:
40406         - Network
40407       summary: see node definition for valid relationships
40408       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40409       consumes:
40410         - application/json
40411         - application/xml
40412       produces:
40413         - application/json
40414         - application/xml
40415       responses:
40416         "default":
40417           description: Response codes found in [response codes](https://wiki.onap.org/).
40418       parameters:
40419         - name: vnf-id
40420           in: path
40421           description: Unique id of VNF.  This is unique across the graph.
40422           required: true
40423           type: string
40424           example: __VNF-ID__
40425         - name: interface-name
40426           in: path
40427           description: Name that identifies the link aggregate interface
40428           required: true
40429           type: string
40430           example: __INTERFACE-NAME__
40431         - name: interface-name
40432           in: path
40433           description: Name given to the interface
40434           required: true
40435           type: string
40436           example: __INTERFACE-NAME__
40437         - name: l3-interface-ipv6-address
40438           in: path
40439           description: IP address
40440           required: true
40441           type: string
40442           example: __L3-INTERFACE-IPV6-ADDRESS__
40443         - name: body
40444           in: body
40445           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40446           required: true
40447           schema:
40448             $ref: "#/definitions/relationship"
40449     delete:
40450       tags:
40451         - Network
40452       summary: delete an existing relationship
40453       description: delete an existing relationship
40454       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40455       consumes:
40456         - application/json
40457         - application/xml
40458       produces:
40459         - application/json
40460         - application/xml
40461       responses:
40462         "default":
40463           description: Response codes found in [response codes](https://wiki.onap.org/).
40464       parameters:
40465         - name: vnf-id
40466           in: path
40467           description: Unique id of VNF.  This is unique across the graph.
40468           required: true
40469           type: string
40470           example: __VNF-ID__
40471         - name: interface-name
40472           in: path
40473           description: Name that identifies the link aggregate interface
40474           required: true
40475           type: string
40476           example: __INTERFACE-NAME__
40477         - name: interface-name
40478           in: path
40479           description: Name given to the interface
40480           required: true
40481           type: string
40482           example: __INTERFACE-NAME__
40483         - name: l3-interface-ipv6-address
40484           in: path
40485           description: IP address
40486           required: true
40487           type: string
40488           example: __L3-INTERFACE-IPV6-ADDRESS__
40489   /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}:
40490     get:
40491       tags:
40492         - Network
40493       summary: returns l3-interface-ipv6-address-list
40494       description: returns l3-interface-ipv6-address-list
40495       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40496       produces:
40497         - application/json
40498         - application/xml
40499       responses:
40500         "200":
40501           description: successful operation
40502           schema:
40503               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40504         "default":
40505           description: Response codes found in [response codes](https://wiki.onap.org/).
40506       parameters:
40507         - name: vnf-id
40508           in: path
40509           description: Unique id of VNF.  This is unique across the graph.
40510           required: true
40511           type: string
40512           example: __VNF-ID__
40513         - name: interface-name
40514           in: path
40515           description: Name that identifies the link aggregate interface
40516           required: true
40517           type: string
40518           example: __INTERFACE-NAME__
40519         - name: interface-name
40520           in: path
40521           description: Name given to the interface
40522           required: true
40523           type: string
40524           example: __INTERFACE-NAME__
40525         - name: l3-interface-ipv6-address
40526           in: path
40527           description: IP address
40528           required: true
40529           type: string
40530           example: __L3-INTERFACE-IPV6-ADDRESS__
40531         - name: vnf-name
40532           in: query
40533           description: Name of VNF.
40534           required: false
40535           type: string
40536         - name: vnf-name2
40537           in: query
40538           description: Alternate name of VNF.
40539           required: false
40540           type: string
40541         - name: vnf-type
40542           in: query
40543           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.
40544           required: false
40545           type: string
40546         - name: service-id
40547           in: query
40548           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40549           required: false
40550           type: string
40551         - name: regional-resource-zone
40552           in: query
40553           description: Regional way of organizing pservers, source of truth should define values
40554           required: false
40555           type: string
40556         - name: prov-status
40557           in: query
40558           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40559           required: false
40560           type: string
40561         - name: heat-stack-id
40562           in: query
40563           description: Heat stack id corresponding to this instance, managed by MSO
40564           required: false
40565           type: string
40566         - name: in-maint
40567           in: query
40568           required: false
40569           type: boolean
40570         - name: is-closed-loop-disabled
40571           in: query
40572           required: false
40573           type: boolean
40574         - name: model-invariant-id
40575           in: query
40576           description: the ASDC model id for this resource or service model.
40577           required: false
40578           type: string
40579         - name: model-version-id
40580           in: query
40581           description: the ASDC model version for this resource or service model.
40582           required: false
40583           type: string
40584         - name: widget-model-id
40585           in: query
40586           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40587           required: false
40588           type: string
40589         - name: widget-model-version
40590           in: query
40591           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40592           required: false
40593           type: string
40594         - name: nf-type
40595           in: query
40596           description: Generic description of the type of NF
40597           required: false
40598           type: string
40599         - name: nf-function
40600           in: query
40601           description: English description of Network function that the specific VNF deployment is providing
40602           required: false
40603           type: string
40604         - name: nf-role
40605           in: query
40606           description: role in the network that this model will be providing
40607           required: false
40608           type: string
40609         - name: nf-naming-code
40610           in: query
40611           description: string assigned to this model used for naming purposes
40612           required: false
40613           type: string
40614         - name: interface-id
40615           in: query
40616           description: ID of interface
40617           required: false
40618           type: string
40619         - name: interface-role
40620           in: query
40621           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40622           required: false
40623           type: string
40624         - name: interface-id
40625           in: query
40626           description: ID of interface
40627           required: false
40628           type: string
40629         - name: macaddr
40630           in: query
40631           description: MAC address for the interface
40632           required: false
40633           type: string
40634         - name: network-name
40635           in: query
40636           description: Name of the network
40637           required: false
40638           type: string
40639         - name: vlan-id-inner
40640           in: query
40641           description: Inner VLAN tag
40642           required: false
40643           type: integer
40644           format: int64
40645         - name: neutron-network-id
40646           in: query
40647           description: Neutron network id of the interface that address belongs to
40648           required: false
40649           type: string
40650         - name: neutron-subnet-id
40651           in: query
40652           description: Neutron id of subnet that address belongs to
40653           required: false
40654           type: string
40655     put:
40656       tags:
40657         - Network
40658       summary: create or update an existing l3-interface-ipv6-address-list
40659       description: |
40660         Create or update an existing l3-interface-ipv6-address-list.
40661         #
40662         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
40663       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40664       consumes:
40665         - application/json
40666         - application/xml
40667       produces:
40668         - application/json
40669         - application/xml
40670       responses:
40671         "default":
40672           description: Response codes found in [response codes](https://wiki.onap.org/).
40673       parameters:
40674         - name: vnf-id
40675           in: path
40676           description: Unique id of VNF.  This is unique across the graph.
40677           required: true
40678           type: string
40679           example: __VNF-ID__
40680         - name: interface-name
40681           in: path
40682           description: Name that identifies the link aggregate interface
40683           required: true
40684           type: string
40685           example: __INTERFACE-NAME__
40686         - name: interface-name
40687           in: path
40688           description: Name given to the interface
40689           required: true
40690           type: string
40691           example: __INTERFACE-NAME__
40692         - name: l3-interface-ipv6-address
40693           in: path
40694           description: IP address
40695           required: true
40696           type: string
40697           example: __L3-INTERFACE-IPV6-ADDRESS__
40698         - name: body
40699           in: body
40700           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40701           required: true
40702           schema:
40703             $ref: "#/definitions/l3-interface-ipv6-address-list"
40704     patch:
40705       tags:
40706         - Network
40707       summary: update an existing l3-interface-ipv6-address-list
40708       description: |
40709         Update an existing l3-interface-ipv6-address-list
40710         #
40711         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40712         The PUT operation will entirely replace an existing object.
40713         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.
40714         #
40715         Other differences between PUT and PATCH are:
40716         #
40717         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40718         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40719         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40720       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40721       consumes:
40722         - application/json
40723         - application/xml
40724       produces:
40725         - application/json
40726         - application/xml
40727       responses:
40728         "default":
40729           description: Response codes found in [response codes](https://wiki.onap.org/).
40730       parameters:
40731         - name: vnf-id
40732           in: path
40733           description: Unique id of VNF.  This is unique across the graph.
40734           required: true
40735           type: string
40736           example: __VNF-ID__
40737         - name: interface-name
40738           in: path
40739           description: Name that identifies the link aggregate interface
40740           required: true
40741           type: string
40742           example: __INTERFACE-NAME__
40743         - name: interface-name
40744           in: path
40745           description: Name given to the interface
40746           required: true
40747           type: string
40748           example: __INTERFACE-NAME__
40749         - name: l3-interface-ipv6-address
40750           in: path
40751           description: IP address
40752           required: true
40753           type: string
40754           example: __L3-INTERFACE-IPV6-ADDRESS__
40755         - name: body
40756           in: body
40757           description: l3-interface-ipv6-address-list object that needs to be created or updated.
40758           required: true
40759           schema:
40760             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40761     delete:
40762       tags:
40763         - Network
40764       summary: delete an existing l3-interface-ipv6-address-list
40765       description: delete an existing l3-interface-ipv6-address-list
40766       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40767       consumes:
40768         - application/json
40769         - application/xml
40770       produces:
40771         - application/json
40772         - application/xml
40773       responses:
40774         "default":
40775           description: Response codes found in [response codes](https://wiki.onap.org/).
40776       parameters:
40777         - name: vnf-id
40778           in: path
40779           description: Unique id of VNF.  This is unique across the graph.
40780           required: true
40781           type: string
40782           example: __VNF-ID__
40783         - name: interface-name
40784           in: path
40785           description: Name that identifies the link aggregate interface
40786           required: true
40787           type: string
40788           example: __INTERFACE-NAME__
40789         - name: interface-name
40790           in: path
40791           description: Name given to the interface
40792           required: true
40793           type: string
40794           example: __INTERFACE-NAME__
40795         - name: l3-interface-ipv6-address
40796           in: path
40797           description: IP address
40798           required: true
40799           type: string
40800           example: __L3-INTERFACE-IPV6-ADDRESS__
40801         - name: resource-version
40802           in: query
40803           description: resource-version for concurrency
40804           required: true
40805           type: string
40806   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
40807     get:
40808       tags:
40809         - Network
40810       summary: returns l-interface
40811       description: returns l-interface
40812       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40813       produces:
40814         - application/json
40815         - application/xml
40816       responses:
40817         "200":
40818           description: successful operation
40819           schema:
40820               $ref: "#/getDefinitions/l-interface"
40821         "default":
40822           description: Response codes found in [response codes](https://wiki.onap.org/).
40823       parameters:
40824         - name: vnf-id
40825           in: path
40826           description: Unique id of VNF.  This is unique across the graph.
40827           required: true
40828           type: string
40829           example: __VNF-ID__
40830         - name: interface-name
40831           in: path
40832           description: Name that identifies the link aggregate interface
40833           required: true
40834           type: string
40835           example: __INTERFACE-NAME__
40836         - name: interface-name
40837           in: path
40838           description: Name given to the interface
40839           required: true
40840           type: string
40841           example: __INTERFACE-NAME__
40842         - name: vnf-name
40843           in: query
40844           description: Name of VNF.
40845           required: false
40846           type: string
40847         - name: vnf-name2
40848           in: query
40849           description: Alternate name of VNF.
40850           required: false
40851           type: string
40852         - name: vnf-type
40853           in: query
40854           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.
40855           required: false
40856           type: string
40857         - name: service-id
40858           in: query
40859           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40860           required: false
40861           type: string
40862         - name: regional-resource-zone
40863           in: query
40864           description: Regional way of organizing pservers, source of truth should define values
40865           required: false
40866           type: string
40867         - name: prov-status
40868           in: query
40869           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40870           required: false
40871           type: string
40872         - name: heat-stack-id
40873           in: query
40874           description: Heat stack id corresponding to this instance, managed by MSO
40875           required: false
40876           type: string
40877         - name: in-maint
40878           in: query
40879           required: false
40880           type: boolean
40881         - name: is-closed-loop-disabled
40882           in: query
40883           required: false
40884           type: boolean
40885         - name: model-invariant-id
40886           in: query
40887           description: the ASDC model id for this resource or service model.
40888           required: false
40889           type: string
40890         - name: model-version-id
40891           in: query
40892           description: the ASDC model version for this resource or service model.
40893           required: false
40894           type: string
40895         - name: widget-model-id
40896           in: query
40897           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40898           required: false
40899           type: string
40900         - name: widget-model-version
40901           in: query
40902           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40903           required: false
40904           type: string
40905         - name: nf-type
40906           in: query
40907           description: Generic description of the type of NF
40908           required: false
40909           type: string
40910         - name: nf-function
40911           in: query
40912           description: English description of Network function that the specific VNF deployment is providing
40913           required: false
40914           type: string
40915         - name: nf-role
40916           in: query
40917           description: role in the network that this model will be providing
40918           required: false
40919           type: string
40920         - name: nf-naming-code
40921           in: query
40922           description: string assigned to this model used for naming purposes
40923           required: false
40924           type: string
40925         - name: interface-id
40926           in: query
40927           description: ID of interface
40928           required: false
40929           type: string
40930         - name: interface-role
40931           in: query
40932           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40933           required: false
40934           type: string
40935         - name: interface-id
40936           in: query
40937           description: ID of interface
40938           required: false
40939           type: string
40940         - name: macaddr
40941           in: query
40942           description: MAC address for the interface
40943           required: false
40944           type: string
40945         - name: network-name
40946           in: query
40947           description: Name of the network
40948           required: false
40949           type: string
40950     put:
40951       tags:
40952         - Network
40953       summary: create or update an existing l-interface
40954       description: |
40955         Create or update an existing l-interface.
40956         #
40957         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
40958       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40959       consumes:
40960         - application/json
40961         - application/xml
40962       produces:
40963         - application/json
40964         - application/xml
40965       responses:
40966         "default":
40967           description: Response codes found in [response codes](https://wiki.onap.org/).
40968       parameters:
40969         - name: vnf-id
40970           in: path
40971           description: Unique id of VNF.  This is unique across the graph.
40972           required: true
40973           type: string
40974           example: __VNF-ID__
40975         - name: interface-name
40976           in: path
40977           description: Name that identifies the link aggregate interface
40978           required: true
40979           type: string
40980           example: __INTERFACE-NAME__
40981         - name: interface-name
40982           in: path
40983           description: Name given to the interface
40984           required: true
40985           type: string
40986           example: __INTERFACE-NAME__
40987         - name: body
40988           in: body
40989           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
40990           required: true
40991           schema:
40992             $ref: "#/definitions/l-interface"
40993     patch:
40994       tags:
40995         - Network
40996       summary: update an existing l-interface
40997       description: |
40998         Update an existing l-interface
40999         #
41000         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41001         The PUT operation will entirely replace an existing object.
41002         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.
41003         #
41004         Other differences between PUT and PATCH are:
41005         #
41006         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41007         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41008         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41009       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
41010       consumes:
41011         - application/json
41012         - application/xml
41013       produces:
41014         - application/json
41015         - application/xml
41016       responses:
41017         "default":
41018           description: Response codes found in [response codes](https://wiki.onap.org/).
41019       parameters:
41020         - name: vnf-id
41021           in: path
41022           description: Unique id of VNF.  This is unique across the graph.
41023           required: true
41024           type: string
41025           example: __VNF-ID__
41026         - name: interface-name
41027           in: path
41028           description: Name that identifies the link aggregate interface
41029           required: true
41030           type: string
41031           example: __INTERFACE-NAME__
41032         - name: interface-name
41033           in: path
41034           description: Name given to the interface
41035           required: true
41036           type: string
41037           example: __INTERFACE-NAME__
41038         - name: body
41039           in: body
41040           description: l-interface object that needs to be created or updated.
41041           required: true
41042           schema:
41043             $ref: "#/patchDefinitions/l-interface"
41044     delete:
41045       tags:
41046         - Network
41047       summary: delete an existing l-interface
41048       description: delete an existing l-interface
41049       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
41050       consumes:
41051         - application/json
41052         - application/xml
41053       produces:
41054         - application/json
41055         - application/xml
41056       responses:
41057         "default":
41058           description: Response codes found in [response codes](https://wiki.onap.org/).
41059       parameters:
41060         - name: vnf-id
41061           in: path
41062           description: Unique id of VNF.  This is unique across the graph.
41063           required: true
41064           type: string
41065           example: __VNF-ID__
41066         - name: interface-name
41067           in: path
41068           description: Name that identifies the link aggregate interface
41069           required: true
41070           type: string
41071           example: __INTERFACE-NAME__
41072         - name: interface-name
41073           in: path
41074           description: Name given to the interface
41075           required: true
41076           type: string
41077           example: __INTERFACE-NAME__
41078         - name: resource-version
41079           in: query
41080           description: resource-version for concurrency
41081           required: true
41082           type: string
41083   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
41084     get:
41085       tags:
41086         - Network
41087       summary: returns l-interfaces
41088       description: returns l-interfaces
41089       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
41090       produces:
41091         - application/json
41092         - application/xml
41093       responses:
41094         "200":
41095           description: successful operation
41096           schema:
41097               $ref: "#/getDefinitions/l-interfaces"
41098         "default":
41099           description: Response codes found in [response codes](https://wiki.onap.org/).
41100       parameters:
41101         - name: vnf-id
41102           in: path
41103           description: Unique id of VNF.  This is unique across the graph.
41104           required: true
41105           type: string
41106           example: __VNF-ID__
41107         - name: interface-name
41108           in: path
41109           description: Name that identifies the link aggregate interface
41110           required: true
41111           type: string
41112           example: __INTERFACE-NAME__
41113         - name: vnf-name
41114           in: query
41115           description: Name of VNF.
41116           required: false
41117           type: string
41118         - name: vnf-name2
41119           in: query
41120           description: Alternate name of VNF.
41121           required: false
41122           type: string
41123         - name: vnf-type
41124           in: query
41125           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.
41126           required: false
41127           type: string
41128         - name: service-id
41129           in: query
41130           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41131           required: false
41132           type: string
41133         - name: regional-resource-zone
41134           in: query
41135           description: Regional way of organizing pservers, source of truth should define values
41136           required: false
41137           type: string
41138         - name: prov-status
41139           in: query
41140           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41141           required: false
41142           type: string
41143         - name: heat-stack-id
41144           in: query
41145           description: Heat stack id corresponding to this instance, managed by MSO
41146           required: false
41147           type: string
41148         - name: in-maint
41149           in: query
41150           required: false
41151           type: boolean
41152         - name: is-closed-loop-disabled
41153           in: query
41154           required: false
41155           type: boolean
41156         - name: model-invariant-id
41157           in: query
41158           description: the ASDC model id for this resource or service model.
41159           required: false
41160           type: string
41161         - name: model-version-id
41162           in: query
41163           description: the ASDC model version for this resource or service model.
41164           required: false
41165           type: string
41166         - name: widget-model-id
41167           in: query
41168           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41169           required: false
41170           type: string
41171         - name: widget-model-version
41172           in: query
41173           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41174           required: false
41175           type: string
41176         - name: nf-type
41177           in: query
41178           description: Generic description of the type of NF
41179           required: false
41180           type: string
41181         - name: nf-function
41182           in: query
41183           description: English description of Network function that the specific VNF deployment is providing
41184           required: false
41185           type: string
41186         - name: nf-role
41187           in: query
41188           description: role in the network that this model will be providing
41189           required: false
41190           type: string
41191         - name: nf-naming-code
41192           in: query
41193           description: string assigned to this model used for naming purposes
41194           required: false
41195           type: string
41196         - name: interface-id
41197           in: query
41198           description: ID of interface
41199           required: false
41200           type: string
41201         - name: interface-role
41202           in: query
41203           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41204           required: false
41205           type: string
41206   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
41207     get:
41208       tags:
41209         - Network
41210       summary: returns lag-interface
41211       description: returns lag-interface
41212       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41213       produces:
41214         - application/json
41215         - application/xml
41216       responses:
41217         "200":
41218           description: successful operation
41219           schema:
41220               $ref: "#/getDefinitions/lag-interface"
41221         "default":
41222           description: Response codes found in [response codes](https://wiki.onap.org/).
41223       parameters:
41224         - name: vnf-id
41225           in: path
41226           description: Unique id of VNF.  This is unique across the graph.
41227           required: true
41228           type: string
41229           example: __VNF-ID__
41230         - name: interface-name
41231           in: path
41232           description: Name that identifies the link aggregate interface
41233           required: true
41234           type: string
41235           example: __INTERFACE-NAME__
41236         - name: vnf-name
41237           in: query
41238           description: Name of VNF.
41239           required: false
41240           type: string
41241         - name: vnf-name2
41242           in: query
41243           description: Alternate name of VNF.
41244           required: false
41245           type: string
41246         - name: vnf-type
41247           in: query
41248           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.
41249           required: false
41250           type: string
41251         - name: service-id
41252           in: query
41253           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41254           required: false
41255           type: string
41256         - name: regional-resource-zone
41257           in: query
41258           description: Regional way of organizing pservers, source of truth should define values
41259           required: false
41260           type: string
41261         - name: prov-status
41262           in: query
41263           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41264           required: false
41265           type: string
41266         - name: heat-stack-id
41267           in: query
41268           description: Heat stack id corresponding to this instance, managed by MSO
41269           required: false
41270           type: string
41271         - name: in-maint
41272           in: query
41273           required: false
41274           type: boolean
41275         - name: is-closed-loop-disabled
41276           in: query
41277           required: false
41278           type: boolean
41279         - name: model-invariant-id
41280           in: query
41281           description: the ASDC model id for this resource or service model.
41282           required: false
41283           type: string
41284         - name: model-version-id
41285           in: query
41286           description: the ASDC model version for this resource or service model.
41287           required: false
41288           type: string
41289         - name: widget-model-id
41290           in: query
41291           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41292           required: false
41293           type: string
41294         - name: widget-model-version
41295           in: query
41296           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41297           required: false
41298           type: string
41299         - name: nf-type
41300           in: query
41301           description: Generic description of the type of NF
41302           required: false
41303           type: string
41304         - name: nf-function
41305           in: query
41306           description: English description of Network function that the specific VNF deployment is providing
41307           required: false
41308           type: string
41309         - name: nf-role
41310           in: query
41311           description: role in the network that this model will be providing
41312           required: false
41313           type: string
41314         - name: nf-naming-code
41315           in: query
41316           description: string assigned to this model used for naming purposes
41317           required: false
41318           type: string
41319         - name: interface-id
41320           in: query
41321           description: ID of interface
41322           required: false
41323           type: string
41324         - name: interface-role
41325           in: query
41326           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
41327           required: false
41328           type: string
41329     put:
41330       tags:
41331         - Network
41332       summary: create or update an existing lag-interface
41333       description: |
41334         Create or update an existing lag-interface.
41335         #
41336         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
41337       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41338       consumes:
41339         - application/json
41340         - application/xml
41341       produces:
41342         - application/json
41343         - application/xml
41344       responses:
41345         "default":
41346           description: Response codes found in [response codes](https://wiki.onap.org/).
41347       parameters:
41348         - name: vnf-id
41349           in: path
41350           description: Unique id of VNF.  This is unique across the graph.
41351           required: true
41352           type: string
41353           example: __VNF-ID__
41354         - name: interface-name
41355           in: path
41356           description: Name that identifies the link aggregate interface
41357           required: true
41358           type: string
41359           example: __INTERFACE-NAME__
41360         - name: body
41361           in: body
41362           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
41363           required: true
41364           schema:
41365             $ref: "#/definitions/lag-interface"
41366     patch:
41367       tags:
41368         - Network
41369       summary: update an existing lag-interface
41370       description: |
41371         Update an existing lag-interface
41372         #
41373         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41374         The PUT operation will entirely replace an existing object.
41375         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.
41376         #
41377         Other differences between PUT and PATCH are:
41378         #
41379         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41380         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41381         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41382       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
41383       consumes:
41384         - application/json
41385         - application/xml
41386       produces:
41387         - application/json
41388         - application/xml
41389       responses:
41390         "default":
41391           description: Response codes found in [response codes](https://wiki.onap.org/).
41392       parameters:
41393         - name: vnf-id
41394           in: path
41395           description: Unique id of VNF.  This is unique across the graph.
41396           required: true
41397           type: string
41398           example: __VNF-ID__
41399         - name: interface-name
41400           in: path
41401           description: Name that identifies the link aggregate interface
41402           required: true
41403           type: string
41404           example: __INTERFACE-NAME__
41405         - name: body
41406           in: body
41407           description: lag-interface object that needs to be created or updated.
41408           required: true
41409           schema:
41410             $ref: "#/patchDefinitions/lag-interface"
41411     delete:
41412       tags:
41413         - Network
41414       summary: delete an existing lag-interface
41415       description: delete an existing lag-interface
41416       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
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: vnf-id
41428           in: path
41429           description: Unique id of VNF.  This is unique across the graph.
41430           required: true
41431           type: string
41432           example: __VNF-ID__
41433         - name: interface-name
41434           in: path
41435           description: Name that identifies the link aggregate interface
41436           required: true
41437           type: string
41438           example: __INTERFACE-NAME__
41439         - name: resource-version
41440           in: query
41441           description: resource-version for concurrency
41442           required: true
41443           type: string
41444   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
41445     get:
41446       tags:
41447         - Network
41448       summary: returns lag-interfaces
41449       description: returns lag-interfaces
41450       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
41451       produces:
41452         - application/json
41453         - application/xml
41454       responses:
41455         "200":
41456           description: successful operation
41457           schema:
41458               $ref: "#/getDefinitions/lag-interfaces"
41459         "default":
41460           description: Response codes found in [response codes](https://wiki.onap.org/).
41461       parameters:
41462         - name: vnf-id
41463           in: path
41464           description: Unique id of VNF.  This is unique across the graph.
41465           required: true
41466           type: string
41467           example: __VNF-ID__
41468         - name: vnf-name
41469           in: query
41470           description: Name of VNF.
41471           required: false
41472           type: string
41473         - name: vnf-name2
41474           in: query
41475           description: Alternate name of VNF.
41476           required: false
41477           type: string
41478         - name: vnf-type
41479           in: query
41480           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.
41481           required: false
41482           type: string
41483         - name: service-id
41484           in: query
41485           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41486           required: false
41487           type: string
41488         - name: regional-resource-zone
41489           in: query
41490           description: Regional way of organizing pservers, source of truth should define values
41491           required: false
41492           type: string
41493         - name: prov-status
41494           in: query
41495           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41496           required: false
41497           type: string
41498         - name: heat-stack-id
41499           in: query
41500           description: Heat stack id corresponding to this instance, managed by MSO
41501           required: false
41502           type: string
41503         - name: in-maint
41504           in: query
41505           required: false
41506           type: boolean
41507         - name: is-closed-loop-disabled
41508           in: query
41509           required: false
41510           type: boolean
41511         - name: model-invariant-id
41512           in: query
41513           description: the ASDC model id for this resource or service model.
41514           required: false
41515           type: string
41516         - name: model-version-id
41517           in: query
41518           description: the ASDC model version for this resource or service model.
41519           required: false
41520           type: string
41521         - name: widget-model-id
41522           in: query
41523           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41524           required: false
41525           type: string
41526         - name: widget-model-version
41527           in: query
41528           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41529           required: false
41530           type: string
41531         - name: nf-type
41532           in: query
41533           description: Generic description of the type of NF
41534           required: false
41535           type: string
41536         - name: nf-function
41537           in: query
41538           description: English description of Network function that the specific VNF deployment is providing
41539           required: false
41540           type: string
41541         - name: nf-role
41542           in: query
41543           description: role in the network that this model will be providing
41544           required: false
41545           type: string
41546         - name: nf-naming-code
41547           in: query
41548           description: string assigned to this model used for naming purposes
41549           required: false
41550           type: string
41551   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
41552     put:
41553       tags:
41554         - Network
41555       summary: see node definition for valid relationships
41556       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
41557       consumes:
41558         - application/json
41559         - application/xml
41560       produces:
41561         - application/json
41562         - application/xml
41563       responses:
41564         "default":
41565           description: Response codes found in [response codes](https://wiki.onap.org/).
41566       parameters:
41567         - name: vnf-id
41568           in: path
41569           description: Unique id of VNF.  This is unique across the graph.
41570           required: true
41571           type: string
41572           example: __VNF-ID__
41573         - name: vf-module-id
41574           in: path
41575           description: Unique ID of vf-module.
41576           required: true
41577           type: string
41578           example: __VF-MODULE-ID__
41579         - name: body
41580           in: body
41581           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
41582           required: true
41583           schema:
41584             $ref: "#/definitions/relationship"
41585     delete:
41586       tags:
41587         - Network
41588       summary: delete an existing relationship
41589       description: delete an existing relationship
41590       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
41591       consumes:
41592         - application/json
41593         - application/xml
41594       produces:
41595         - application/json
41596         - application/xml
41597       responses:
41598         "default":
41599           description: Response codes found in [response codes](https://wiki.onap.org/).
41600       parameters:
41601         - name: vnf-id
41602           in: path
41603           description: Unique id of VNF.  This is unique across the graph.
41604           required: true
41605           type: string
41606           example: __VNF-ID__
41607         - name: vf-module-id
41608           in: path
41609           description: Unique ID of vf-module.
41610           required: true
41611           type: string
41612           example: __VF-MODULE-ID__
41613   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
41614     get:
41615       tags:
41616         - Network
41617       summary: returns vf-module
41618       description: returns vf-module
41619       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
41620       produces:
41621         - application/json
41622         - application/xml
41623       responses:
41624         "200":
41625           description: successful operation
41626           schema:
41627               $ref: "#/getDefinitions/vf-module"
41628         "default":
41629           description: Response codes found in [response codes](https://wiki.onap.org/).
41630       parameters:
41631         - name: vnf-id
41632           in: path
41633           description: Unique id of VNF.  This is unique across the graph.
41634           required: true
41635           type: string
41636           example: __VNF-ID__
41637         - name: vf-module-id
41638           in: path
41639           description: Unique ID of vf-module.
41640           required: true
41641           type: string
41642           example: __VF-MODULE-ID__
41643         - name: vnf-name
41644           in: query
41645           description: Name of VNF.
41646           required: false
41647           type: string
41648         - name: vnf-name2
41649           in: query
41650           description: Alternate name of VNF.
41651           required: false
41652           type: string
41653         - name: vnf-type
41654           in: query
41655           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.
41656           required: false
41657           type: string
41658         - name: service-id
41659           in: query
41660           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41661           required: false
41662           type: string
41663         - name: regional-resource-zone
41664           in: query
41665           description: Regional way of organizing pservers, source of truth should define values
41666           required: false
41667           type: string
41668         - name: prov-status
41669           in: query
41670           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41671           required: false
41672           type: string
41673         - name: heat-stack-id
41674           in: query
41675           description: Heat stack id corresponding to this instance, managed by MSO
41676           required: false
41677           type: string
41678         - name: in-maint
41679           in: query
41680           required: false
41681           type: boolean
41682         - name: is-closed-loop-disabled
41683           in: query
41684           required: false
41685           type: boolean
41686         - name: model-invariant-id
41687           in: query
41688           description: the ASDC model id for this resource or service model.
41689           required: false
41690           type: string
41691         - name: model-version-id
41692           in: query
41693           description: the ASDC model version for this resource or service model.
41694           required: false
41695           type: string
41696         - name: widget-model-id
41697           in: query
41698           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41699           required: false
41700           type: string
41701         - name: widget-model-version
41702           in: query
41703           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41704           required: false
41705           type: string
41706         - name: nf-type
41707           in: query
41708           description: Generic description of the type of NF
41709           required: false
41710           type: string
41711         - name: nf-function
41712           in: query
41713           description: English description of Network function that the specific VNF deployment is providing
41714           required: false
41715           type: string
41716         - name: nf-role
41717           in: query
41718           description: role in the network that this model will be providing
41719           required: false
41720           type: string
41721         - name: nf-naming-code
41722           in: query
41723           description: string assigned to this model used for naming purposes
41724           required: false
41725           type: string
41726         - name: vf-module-name
41727           in: query
41728           description: Name of vf-module
41729           required: false
41730           type: string
41731         - name: heat-stack-id
41732           in: query
41733           description: Heat stack id corresponding to this instance.
41734           required: false
41735           type: string
41736         - name: model-invariant-id
41737           in: query
41738           description: the ASDC model id for this resource or service model.
41739           required: false
41740           type: string
41741         - name: model-version-id
41742           in: query
41743           description: the ASDC model version for this resource or service model.
41744           required: false
41745           type: string
41746         - name: widget-model-id
41747           in: query
41748           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41749           required: false
41750           type: string
41751         - name: widget-model-version
41752           in: query
41753           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41754           required: false
41755           type: string
41756         - name: contrail-service-instance-fqdn
41757           in: query
41758           description: the Contrail unique ID for a service-instance
41759           required: false
41760           type: string
41761     put:
41762       tags:
41763         - Network
41764       summary: create or update an existing vf-module
41765       description: |
41766         Create or update an existing vf-module.
41767         #
41768         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
41769       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
41770       consumes:
41771         - application/json
41772         - application/xml
41773       produces:
41774         - application/json
41775         - application/xml
41776       responses:
41777         "default":
41778           description: Response codes found in [response codes](https://wiki.onap.org/).
41779       parameters:
41780         - name: vnf-id
41781           in: path
41782           description: Unique id of VNF.  This is unique across the graph.
41783           required: true
41784           type: string
41785           example: __VNF-ID__
41786         - name: vf-module-id
41787           in: path
41788           description: Unique ID of vf-module.
41789           required: true
41790           type: string
41791           example: __VF-MODULE-ID__
41792         - name: body
41793           in: body
41794           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
41795           required: true
41796           schema:
41797             $ref: "#/definitions/vf-module"
41798     patch:
41799       tags:
41800         - Network
41801       summary: update an existing vf-module
41802       description: |
41803         Update an existing vf-module
41804         #
41805         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41806         The PUT operation will entirely replace an existing object.
41807         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.
41808         #
41809         Other differences between PUT and PATCH are:
41810         #
41811         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41812         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41813         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41814       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
41815       consumes:
41816         - application/json
41817         - application/xml
41818       produces:
41819         - application/json
41820         - application/xml
41821       responses:
41822         "default":
41823           description: Response codes found in [response codes](https://wiki.onap.org/).
41824       parameters:
41825         - name: vnf-id
41826           in: path
41827           description: Unique id of VNF.  This is unique across the graph.
41828           required: true
41829           type: string
41830           example: __VNF-ID__
41831         - name: vf-module-id
41832           in: path
41833           description: Unique ID of vf-module.
41834           required: true
41835           type: string
41836           example: __VF-MODULE-ID__
41837         - name: body
41838           in: body
41839           description: vf-module object that needs to be created or updated.
41840           required: true
41841           schema:
41842             $ref: "#/patchDefinitions/vf-module"
41843     delete:
41844       tags:
41845         - Network
41846       summary: delete an existing vf-module
41847       description: delete an existing vf-module
41848       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
41849       consumes:
41850         - application/json
41851         - application/xml
41852       produces:
41853         - application/json
41854         - application/xml
41855       responses:
41856         "default":
41857           description: Response codes found in [response codes](https://wiki.onap.org/).
41858       parameters:
41859         - name: vnf-id
41860           in: path
41861           description: Unique id of VNF.  This is unique across the graph.
41862           required: true
41863           type: string
41864           example: __VNF-ID__
41865         - name: vf-module-id
41866           in: path
41867           description: Unique ID of vf-module.
41868           required: true
41869           type: string
41870           example: __VF-MODULE-ID__
41871         - name: resource-version
41872           in: query
41873           description: resource-version for concurrency
41874           required: true
41875           type: string
41876   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
41877     get:
41878       tags:
41879         - Network
41880       summary: returns vf-modules
41881       description: returns vf-modules
41882       operationId: getNetworkGenericVnfsGenericVnfVfModules
41883       produces:
41884         - application/json
41885         - application/xml
41886       responses:
41887         "200":
41888           description: successful operation
41889           schema:
41890               $ref: "#/getDefinitions/vf-modules"
41891         "default":
41892           description: Response codes found in [response codes](https://wiki.onap.org/).
41893       parameters:
41894         - name: vnf-id
41895           in: path
41896           description: Unique id of VNF.  This is unique across the graph.
41897           required: true
41898           type: string
41899           example: __VNF-ID__
41900         - name: vnf-name
41901           in: query
41902           description: Name of VNF.
41903           required: false
41904           type: string
41905         - name: vnf-name2
41906           in: query
41907           description: Alternate name of VNF.
41908           required: false
41909           type: string
41910         - name: vnf-type
41911           in: query
41912           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.
41913           required: false
41914           type: string
41915         - name: service-id
41916           in: query
41917           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41918           required: false
41919           type: string
41920         - name: regional-resource-zone
41921           in: query
41922           description: Regional way of organizing pservers, source of truth should define values
41923           required: false
41924           type: string
41925         - name: prov-status
41926           in: query
41927           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41928           required: false
41929           type: string
41930         - name: heat-stack-id
41931           in: query
41932           description: Heat stack id corresponding to this instance, managed by MSO
41933           required: false
41934           type: string
41935         - name: in-maint
41936           in: query
41937           required: false
41938           type: boolean
41939         - name: is-closed-loop-disabled
41940           in: query
41941           required: false
41942           type: boolean
41943         - name: model-invariant-id
41944           in: query
41945           description: the ASDC model id for this resource or service model.
41946           required: false
41947           type: string
41948         - name: model-version-id
41949           in: query
41950           description: the ASDC model version for this resource or service model.
41951           required: false
41952           type: string
41953         - name: widget-model-id
41954           in: query
41955           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41956           required: false
41957           type: string
41958         - name: widget-model-version
41959           in: query
41960           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41961           required: false
41962           type: string
41963         - name: nf-type
41964           in: query
41965           description: Generic description of the type of NF
41966           required: false
41967           type: string
41968         - name: nf-function
41969           in: query
41970           description: English description of Network function that the specific VNF deployment is providing
41971           required: false
41972           type: string
41973         - name: nf-role
41974           in: query
41975           description: role in the network that this model will be providing
41976           required: false
41977           type: string
41978         - name: nf-naming-code
41979           in: query
41980           description: string assigned to this model used for naming purposes
41981           required: false
41982           type: string
41983   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41984     put:
41985       tags:
41986         - Network
41987       summary: see node definition for valid relationships
41988       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41989       consumes:
41990         - application/json
41991         - application/xml
41992       produces:
41993         - application/json
41994         - application/xml
41995       responses:
41996         "default":
41997           description: Response codes found in [response codes](https://wiki.onap.org/).
41998       parameters:
41999         - name: vnf-id
42000           in: path
42001           description: Unique id of VNF.  This is unique across the graph.
42002           required: true
42003           type: string
42004           example: __VNF-ID__
42005         - name: group-uuid
42006           in: path
42007           description: Unique ID for the license group the resource belongs to, should be uuid.
42008           required: true
42009           type: string
42010           example: __GROUP-UUID__
42011         - name: resource-uuid
42012           in: path
42013           description: Unique ID of a license resource.
42014           required: true
42015           type: string
42016           example: __RESOURCE-UUID__
42017         - name: body
42018           in: body
42019           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
42020           required: true
42021           schema:
42022             $ref: "#/definitions/relationship"
42023     delete:
42024       tags:
42025         - Network
42026       summary: delete an existing relationship
42027       description: delete an existing relationship
42028       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
42029       consumes:
42030         - application/json
42031         - application/xml
42032       produces:
42033         - application/json
42034         - application/xml
42035       responses:
42036         "default":
42037           description: Response codes found in [response codes](https://wiki.onap.org/).
42038       parameters:
42039         - name: vnf-id
42040           in: path
42041           description: Unique id of VNF.  This is unique across the graph.
42042           required: true
42043           type: string
42044           example: __VNF-ID__
42045         - name: group-uuid
42046           in: path
42047           description: Unique ID for the license group the resource belongs to, should be uuid.
42048           required: true
42049           type: string
42050           example: __GROUP-UUID__
42051         - name: resource-uuid
42052           in: path
42053           description: Unique ID of a license resource.
42054           required: true
42055           type: string
42056           example: __RESOURCE-UUID__
42057   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
42058     get:
42059       tags:
42060         - Network
42061       summary: returns license
42062       description: returns license
42063       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
42064       produces:
42065         - application/json
42066         - application/xml
42067       responses:
42068         "200":
42069           description: successful operation
42070           schema:
42071               $ref: "#/getDefinitions/license"
42072         "default":
42073           description: Response codes found in [response codes](https://wiki.onap.org/).
42074       parameters:
42075         - name: vnf-id
42076           in: path
42077           description: Unique id of VNF.  This is unique across the graph.
42078           required: true
42079           type: string
42080           example: __VNF-ID__
42081         - name: group-uuid
42082           in: path
42083           description: Unique ID for the license group the resource belongs to, should be uuid.
42084           required: true
42085           type: string
42086           example: __GROUP-UUID__
42087         - name: resource-uuid
42088           in: path
42089           description: Unique ID of a license resource.
42090           required: true
42091           type: string
42092           example: __RESOURCE-UUID__
42093         - name: vnf-name
42094           in: query
42095           description: Name of VNF.
42096           required: false
42097           type: string
42098         - name: vnf-name2
42099           in: query
42100           description: Alternate name of VNF.
42101           required: false
42102           type: string
42103         - name: vnf-type
42104           in: query
42105           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.
42106           required: false
42107           type: string
42108         - name: service-id
42109           in: query
42110           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42111           required: false
42112           type: string
42113         - name: regional-resource-zone
42114           in: query
42115           description: Regional way of organizing pservers, source of truth should define values
42116           required: false
42117           type: string
42118         - name: prov-status
42119           in: query
42120           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42121           required: false
42122           type: string
42123         - name: heat-stack-id
42124           in: query
42125           description: Heat stack id corresponding to this instance, managed by MSO
42126           required: false
42127           type: string
42128         - name: in-maint
42129           in: query
42130           required: false
42131           type: boolean
42132         - name: is-closed-loop-disabled
42133           in: query
42134           required: false
42135           type: boolean
42136         - name: model-invariant-id
42137           in: query
42138           description: the ASDC model id for this resource or service model.
42139           required: false
42140           type: string
42141         - name: model-version-id
42142           in: query
42143           description: the ASDC model version for this resource or service model.
42144           required: false
42145           type: string
42146         - name: widget-model-id
42147           in: query
42148           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42149           required: false
42150           type: string
42151         - name: widget-model-version
42152           in: query
42153           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42154           required: false
42155           type: string
42156         - name: nf-type
42157           in: query
42158           description: Generic description of the type of NF
42159           required: false
42160           type: string
42161         - name: nf-function
42162           in: query
42163           description: English description of Network function that the specific VNF deployment is providing
42164           required: false
42165           type: string
42166         - name: nf-role
42167           in: query
42168           description: role in the network that this model will be providing
42169           required: false
42170           type: string
42171         - name: nf-naming-code
42172           in: query
42173           description: string assigned to this model used for naming purposes
42174           required: false
42175           type: string
42176     put:
42177       tags:
42178         - Network
42179       summary: create or update an existing license
42180       description: |
42181         Create or update an existing license.
42182         #
42183         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
42184       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
42185       consumes:
42186         - application/json
42187         - application/xml
42188       produces:
42189         - application/json
42190         - application/xml
42191       responses:
42192         "default":
42193           description: Response codes found in [response codes](https://wiki.onap.org/).
42194       parameters:
42195         - name: vnf-id
42196           in: path
42197           description: Unique id of VNF.  This is unique across the graph.
42198           required: true
42199           type: string
42200           example: __VNF-ID__
42201         - name: group-uuid
42202           in: path
42203           description: Unique ID for the license group the resource belongs to, should be uuid.
42204           required: true
42205           type: string
42206           example: __GROUP-UUID__
42207         - name: resource-uuid
42208           in: path
42209           description: Unique ID of a license resource.
42210           required: true
42211           type: string
42212           example: __RESOURCE-UUID__
42213         - name: body
42214           in: body
42215           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
42216           required: true
42217           schema:
42218             $ref: "#/definitions/license"
42219     patch:
42220       tags:
42221         - Network
42222       summary: update an existing license
42223       description: |
42224         Update an existing license
42225         #
42226         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42227         The PUT operation will entirely replace an existing object.
42228         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.
42229         #
42230         Other differences between PUT and PATCH are:
42231         #
42232         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42233         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42234         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42235       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
42236       consumes:
42237         - application/json
42238         - application/xml
42239       produces:
42240         - application/json
42241         - application/xml
42242       responses:
42243         "default":
42244           description: Response codes found in [response codes](https://wiki.onap.org/).
42245       parameters:
42246         - name: vnf-id
42247           in: path
42248           description: Unique id of VNF.  This is unique across the graph.
42249           required: true
42250           type: string
42251           example: __VNF-ID__
42252         - name: group-uuid
42253           in: path
42254           description: Unique ID for the license group the resource belongs to, should be uuid.
42255           required: true
42256           type: string
42257           example: __GROUP-UUID__
42258         - name: resource-uuid
42259           in: path
42260           description: Unique ID of a license resource.
42261           required: true
42262           type: string
42263           example: __RESOURCE-UUID__
42264         - name: body
42265           in: body
42266           description: license object that needs to be created or updated.
42267           required: true
42268           schema:
42269             $ref: "#/patchDefinitions/license"
42270     delete:
42271       tags:
42272         - Network
42273       summary: delete an existing license
42274       description: delete an existing license
42275       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
42276       consumes:
42277         - application/json
42278         - application/xml
42279       produces:
42280         - application/json
42281         - application/xml
42282       responses:
42283         "default":
42284           description: Response codes found in [response codes](https://wiki.onap.org/).
42285       parameters:
42286         - name: vnf-id
42287           in: path
42288           description: Unique id of VNF.  This is unique across the graph.
42289           required: true
42290           type: string
42291           example: __VNF-ID__
42292         - name: group-uuid
42293           in: path
42294           description: Unique ID for the license group the resource belongs to, should be uuid.
42295           required: true
42296           type: string
42297           example: __GROUP-UUID__
42298         - name: resource-uuid
42299           in: path
42300           description: Unique ID of a license resource.
42301           required: true
42302           type: string
42303           example: __RESOURCE-UUID__
42304         - name: resource-version
42305           in: query
42306           description: resource-version for concurrency
42307           required: true
42308           type: string
42309   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
42310     get:
42311       tags:
42312         - Network
42313       summary: returns licenses
42314       description: returns licenses
42315       operationId: getNetworkGenericVnfsGenericVnfLicenses
42316       produces:
42317         - application/json
42318         - application/xml
42319       responses:
42320         "200":
42321           description: successful operation
42322           schema:
42323               $ref: "#/getDefinitions/licenses"
42324         "default":
42325           description: Response codes found in [response codes](https://wiki.onap.org/).
42326       parameters:
42327         - name: vnf-id
42328           in: path
42329           description: Unique id of VNF.  This is unique across the graph.
42330           required: true
42331           type: string
42332           example: __VNF-ID__
42333         - name: vnf-name
42334           in: query
42335           description: Name of VNF.
42336           required: false
42337           type: string
42338         - name: vnf-name2
42339           in: query
42340           description: Alternate name of VNF.
42341           required: false
42342           type: string
42343         - name: vnf-type
42344           in: query
42345           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.
42346           required: false
42347           type: string
42348         - name: service-id
42349           in: query
42350           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42351           required: false
42352           type: string
42353         - name: regional-resource-zone
42354           in: query
42355           description: Regional way of organizing pservers, source of truth should define values
42356           required: false
42357           type: string
42358         - name: prov-status
42359           in: query
42360           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42361           required: false
42362           type: string
42363         - name: heat-stack-id
42364           in: query
42365           description: Heat stack id corresponding to this instance, managed by MSO
42366           required: false
42367           type: string
42368         - name: in-maint
42369           in: query
42370           required: false
42371           type: boolean
42372         - name: is-closed-loop-disabled
42373           in: query
42374           required: false
42375           type: boolean
42376         - name: model-invariant-id
42377           in: query
42378           description: the ASDC model id for this resource or service model.
42379           required: false
42380           type: string
42381         - name: model-version-id
42382           in: query
42383           description: the ASDC model version for this resource or service model.
42384           required: false
42385           type: string
42386         - name: widget-model-id
42387           in: query
42388           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42389           required: false
42390           type: string
42391         - name: widget-model-version
42392           in: query
42393           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42394           required: false
42395           type: string
42396         - name: nf-type
42397           in: query
42398           description: Generic description of the type of NF
42399           required: false
42400           type: string
42401         - name: nf-function
42402           in: query
42403           description: English description of Network function that the specific VNF deployment is providing
42404           required: false
42405           type: string
42406         - name: nf-role
42407           in: query
42408           description: role in the network that this model will be providing
42409           required: false
42410           type: string
42411         - name: nf-naming-code
42412           in: query
42413           description: string assigned to this model used for naming purposes
42414           required: false
42415           type: string
42416   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
42417     put:
42418       tags:
42419         - Network
42420       summary: see node definition for valid relationships
42421       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
42422       consumes:
42423         - application/json
42424         - application/xml
42425       produces:
42426         - application/json
42427         - application/xml
42428       responses:
42429         "default":
42430           description: Response codes found in [response codes](https://wiki.onap.org/).
42431       parameters:
42432         - name: vnf-id
42433           in: path
42434           description: Unique id of VNF.  This is unique across the graph.
42435           required: true
42436           type: string
42437           example: __VNF-ID__
42438         - name: group-uuid
42439           in: path
42440           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42441           required: true
42442           type: string
42443           example: __GROUP-UUID__
42444         - name: resource-uuid
42445           in: path
42446           description: Unique ID of an entitlement resource.
42447           required: true
42448           type: string
42449           example: __RESOURCE-UUID__
42450         - name: body
42451           in: body
42452           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
42453           required: true
42454           schema:
42455             $ref: "#/definitions/relationship"
42456     delete:
42457       tags:
42458         - Network
42459       summary: delete an existing relationship
42460       description: delete an existing relationship
42461       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
42462       consumes:
42463         - application/json
42464         - application/xml
42465       produces:
42466         - application/json
42467         - application/xml
42468       responses:
42469         "default":
42470           description: Response codes found in [response codes](https://wiki.onap.org/).
42471       parameters:
42472         - name: vnf-id
42473           in: path
42474           description: Unique id of VNF.  This is unique across the graph.
42475           required: true
42476           type: string
42477           example: __VNF-ID__
42478         - name: group-uuid
42479           in: path
42480           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42481           required: true
42482           type: string
42483           example: __GROUP-UUID__
42484         - name: resource-uuid
42485           in: path
42486           description: Unique ID of an entitlement resource.
42487           required: true
42488           type: string
42489           example: __RESOURCE-UUID__
42490   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
42491     get:
42492       tags:
42493         - Network
42494       summary: returns entitlement
42495       description: returns entitlement
42496       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
42497       produces:
42498         - application/json
42499         - application/xml
42500       responses:
42501         "200":
42502           description: successful operation
42503           schema:
42504               $ref: "#/getDefinitions/entitlement"
42505         "default":
42506           description: Response codes found in [response codes](https://wiki.onap.org/).
42507       parameters:
42508         - name: vnf-id
42509           in: path
42510           description: Unique id of VNF.  This is unique across the graph.
42511           required: true
42512           type: string
42513           example: __VNF-ID__
42514         - name: group-uuid
42515           in: path
42516           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42517           required: true
42518           type: string
42519           example: __GROUP-UUID__
42520         - name: resource-uuid
42521           in: path
42522           description: Unique ID of an entitlement resource.
42523           required: true
42524           type: string
42525           example: __RESOURCE-UUID__
42526         - name: vnf-name
42527           in: query
42528           description: Name of VNF.
42529           required: false
42530           type: string
42531         - name: vnf-name2
42532           in: query
42533           description: Alternate name of VNF.
42534           required: false
42535           type: string
42536         - name: vnf-type
42537           in: query
42538           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.
42539           required: false
42540           type: string
42541         - name: service-id
42542           in: query
42543           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42544           required: false
42545           type: string
42546         - name: regional-resource-zone
42547           in: query
42548           description: Regional way of organizing pservers, source of truth should define values
42549           required: false
42550           type: string
42551         - name: prov-status
42552           in: query
42553           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42554           required: false
42555           type: string
42556         - name: heat-stack-id
42557           in: query
42558           description: Heat stack id corresponding to this instance, managed by MSO
42559           required: false
42560           type: string
42561         - name: in-maint
42562           in: query
42563           required: false
42564           type: boolean
42565         - name: is-closed-loop-disabled
42566           in: query
42567           required: false
42568           type: boolean
42569         - name: model-invariant-id
42570           in: query
42571           description: the ASDC model id for this resource or service model.
42572           required: false
42573           type: string
42574         - name: model-version-id
42575           in: query
42576           description: the ASDC model version for this resource or service model.
42577           required: false
42578           type: string
42579         - name: widget-model-id
42580           in: query
42581           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42582           required: false
42583           type: string
42584         - name: widget-model-version
42585           in: query
42586           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42587           required: false
42588           type: string
42589         - name: nf-type
42590           in: query
42591           description: Generic description of the type of NF
42592           required: false
42593           type: string
42594         - name: nf-function
42595           in: query
42596           description: English description of Network function that the specific VNF deployment is providing
42597           required: false
42598           type: string
42599         - name: nf-role
42600           in: query
42601           description: role in the network that this model will be providing
42602           required: false
42603           type: string
42604         - name: nf-naming-code
42605           in: query
42606           description: string assigned to this model used for naming purposes
42607           required: false
42608           type: string
42609     put:
42610       tags:
42611         - Network
42612       summary: create or update an existing entitlement
42613       description: |
42614         Create or update an existing entitlement.
42615         #
42616         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
42617       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
42618       consumes:
42619         - application/json
42620         - application/xml
42621       produces:
42622         - application/json
42623         - application/xml
42624       responses:
42625         "default":
42626           description: Response codes found in [response codes](https://wiki.onap.org/).
42627       parameters:
42628         - name: vnf-id
42629           in: path
42630           description: Unique id of VNF.  This is unique across the graph.
42631           required: true
42632           type: string
42633           example: __VNF-ID__
42634         - name: group-uuid
42635           in: path
42636           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42637           required: true
42638           type: string
42639           example: __GROUP-UUID__
42640         - name: resource-uuid
42641           in: path
42642           description: Unique ID of an entitlement resource.
42643           required: true
42644           type: string
42645           example: __RESOURCE-UUID__
42646         - name: body
42647           in: body
42648           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
42649           required: true
42650           schema:
42651             $ref: "#/definitions/entitlement"
42652     patch:
42653       tags:
42654         - Network
42655       summary: update an existing entitlement
42656       description: |
42657         Update an existing entitlement
42658         #
42659         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42660         The PUT operation will entirely replace an existing object.
42661         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.
42662         #
42663         Other differences between PUT and PATCH are:
42664         #
42665         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42666         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42667         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42668       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
42669       consumes:
42670         - application/json
42671         - application/xml
42672       produces:
42673         - application/json
42674         - application/xml
42675       responses:
42676         "default":
42677           description: Response codes found in [response codes](https://wiki.onap.org/).
42678       parameters:
42679         - name: vnf-id
42680           in: path
42681           description: Unique id of VNF.  This is unique across the graph.
42682           required: true
42683           type: string
42684           example: __VNF-ID__
42685         - name: group-uuid
42686           in: path
42687           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42688           required: true
42689           type: string
42690           example: __GROUP-UUID__
42691         - name: resource-uuid
42692           in: path
42693           description: Unique ID of an entitlement resource.
42694           required: true
42695           type: string
42696           example: __RESOURCE-UUID__
42697         - name: body
42698           in: body
42699           description: entitlement object that needs to be created or updated.
42700           required: true
42701           schema:
42702             $ref: "#/patchDefinitions/entitlement"
42703     delete:
42704       tags:
42705         - Network
42706       summary: delete an existing entitlement
42707       description: delete an existing entitlement
42708       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
42709       consumes:
42710         - application/json
42711         - application/xml
42712       produces:
42713         - application/json
42714         - application/xml
42715       responses:
42716         "default":
42717           description: Response codes found in [response codes](https://wiki.onap.org/).
42718       parameters:
42719         - name: vnf-id
42720           in: path
42721           description: Unique id of VNF.  This is unique across the graph.
42722           required: true
42723           type: string
42724           example: __VNF-ID__
42725         - name: group-uuid
42726           in: path
42727           description: Unique ID for the entitlement group the resource comes from, should be uuid.
42728           required: true
42729           type: string
42730           example: __GROUP-UUID__
42731         - name: resource-uuid
42732           in: path
42733           description: Unique ID of an entitlement resource.
42734           required: true
42735           type: string
42736           example: __RESOURCE-UUID__
42737         - name: resource-version
42738           in: query
42739           description: resource-version for concurrency
42740           required: true
42741           type: string
42742   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
42743     get:
42744       tags:
42745         - Network
42746       summary: returns entitlements
42747       description: returns entitlements
42748       operationId: getNetworkGenericVnfsGenericVnfEntitlements
42749       produces:
42750         - application/json
42751         - application/xml
42752       responses:
42753         "200":
42754           description: successful operation
42755           schema:
42756               $ref: "#/getDefinitions/entitlements"
42757         "default":
42758           description: Response codes found in [response codes](https://wiki.onap.org/).
42759       parameters:
42760         - name: vnf-id
42761           in: path
42762           description: Unique id of VNF.  This is unique across the graph.
42763           required: true
42764           type: string
42765           example: __VNF-ID__
42766         - name: vnf-name
42767           in: query
42768           description: Name of VNF.
42769           required: false
42770           type: string
42771         - name: vnf-name2
42772           in: query
42773           description: Alternate name of VNF.
42774           required: false
42775           type: string
42776         - name: vnf-type
42777           in: query
42778           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.
42779           required: false
42780           type: string
42781         - name: service-id
42782           in: query
42783           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42784           required: false
42785           type: string
42786         - name: regional-resource-zone
42787           in: query
42788           description: Regional way of organizing pservers, source of truth should define values
42789           required: false
42790           type: string
42791         - name: prov-status
42792           in: query
42793           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42794           required: false
42795           type: string
42796         - name: heat-stack-id
42797           in: query
42798           description: Heat stack id corresponding to this instance, managed by MSO
42799           required: false
42800           type: string
42801         - name: in-maint
42802           in: query
42803           required: false
42804           type: boolean
42805         - name: is-closed-loop-disabled
42806           in: query
42807           required: false
42808           type: boolean
42809         - name: model-invariant-id
42810           in: query
42811           description: the ASDC model id for this resource or service model.
42812           required: false
42813           type: string
42814         - name: model-version-id
42815           in: query
42816           description: the ASDC model version for this resource or service model.
42817           required: false
42818           type: string
42819         - name: widget-model-id
42820           in: query
42821           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42822           required: false
42823           type: string
42824         - name: widget-model-version
42825           in: query
42826           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42827           required: false
42828           type: string
42829         - name: nf-type
42830           in: query
42831           description: Generic description of the type of NF
42832           required: false
42833           type: string
42834         - name: nf-function
42835           in: query
42836           description: English description of Network function that the specific VNF deployment is providing
42837           required: false
42838           type: string
42839         - name: nf-role
42840           in: query
42841           description: role in the network that this model will be providing
42842           required: false
42843           type: string
42844         - name: nf-naming-code
42845           in: query
42846           description: string assigned to this model used for naming purposes
42847           required: false
42848           type: string
42849   /network/generic-vnfs/generic-vnf/{vnf-id}:
42850     get:
42851       tags:
42852         - Network
42853       summary: returns generic-vnf
42854       description: returns generic-vnf
42855       operationId: getNetworkGenericVnfsGenericVnf
42856       produces:
42857         - application/json
42858         - application/xml
42859       responses:
42860         "200":
42861           description: successful operation
42862           schema:
42863               $ref: "#/getDefinitions/generic-vnf"
42864         "default":
42865           description: Response codes found in [response codes](https://wiki.onap.org/).
42866       parameters:
42867         - name: vnf-id
42868           in: path
42869           description: Unique id of VNF.  This is unique across the graph.
42870           required: true
42871           type: string
42872           example: __VNF-ID__
42873         - name: vnf-name
42874           in: query
42875           description: Name of VNF.
42876           required: false
42877           type: string
42878         - name: vnf-name2
42879           in: query
42880           description: Alternate name of VNF.
42881           required: false
42882           type: string
42883         - name: vnf-type
42884           in: query
42885           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.
42886           required: false
42887           type: string
42888         - name: service-id
42889           in: query
42890           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42891           required: false
42892           type: string
42893         - name: regional-resource-zone
42894           in: query
42895           description: Regional way of organizing pservers, source of truth should define values
42896           required: false
42897           type: string
42898         - name: prov-status
42899           in: query
42900           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42901           required: false
42902           type: string
42903         - name: heat-stack-id
42904           in: query
42905           description: Heat stack id corresponding to this instance, managed by MSO
42906           required: false
42907           type: string
42908         - name: in-maint
42909           in: query
42910           required: false
42911           type: boolean
42912         - name: is-closed-loop-disabled
42913           in: query
42914           required: false
42915           type: boolean
42916         - name: model-invariant-id
42917           in: query
42918           description: the ASDC model id for this resource or service model.
42919           required: false
42920           type: string
42921         - name: model-version-id
42922           in: query
42923           description: the ASDC model version for this resource or service model.
42924           required: false
42925           type: string
42926         - name: widget-model-id
42927           in: query
42928           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42929           required: false
42930           type: string
42931         - name: widget-model-version
42932           in: query
42933           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42934           required: false
42935           type: string
42936         - name: nf-type
42937           in: query
42938           description: Generic description of the type of NF
42939           required: false
42940           type: string
42941         - name: nf-function
42942           in: query
42943           description: English description of Network function that the specific VNF deployment is providing
42944           required: false
42945           type: string
42946         - name: nf-role
42947           in: query
42948           description: role in the network that this model will be providing
42949           required: false
42950           type: string
42951         - name: nf-naming-code
42952           in: query
42953           description: string assigned to this model used for naming purposes
42954           required: false
42955           type: string
42956     put:
42957       tags:
42958         - Network
42959       summary: create or update an existing generic-vnf
42960       description: |
42961         Create or update an existing generic-vnf.
42962         #
42963         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
42964       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
42965       consumes:
42966         - application/json
42967         - application/xml
42968       produces:
42969         - application/json
42970         - application/xml
42971       responses:
42972         "default":
42973           description: Response codes found in [response codes](https://wiki.onap.org/).
42974       parameters:
42975         - name: vnf-id
42976           in: path
42977           description: Unique id of VNF.  This is unique across the graph.
42978           required: true
42979           type: string
42980           example: __VNF-ID__
42981         - name: body
42982           in: body
42983           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
42984           required: true
42985           schema:
42986             $ref: "#/definitions/generic-vnf"
42987     patch:
42988       tags:
42989         - Network
42990       summary: update an existing generic-vnf
42991       description: |
42992         Update an existing generic-vnf
42993         #
42994         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42995         The PUT operation will entirely replace an existing object.
42996         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.
42997         #
42998         Other differences between PUT and PATCH are:
42999         #
43000         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43001         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43002         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43003       operationId: UpdateNetworkGenericVnfsGenericVnf
43004       consumes:
43005         - application/json
43006         - application/xml
43007       produces:
43008         - application/json
43009         - application/xml
43010       responses:
43011         "default":
43012           description: Response codes found in [response codes](https://wiki.onap.org/).
43013       parameters:
43014         - name: vnf-id
43015           in: path
43016           description: Unique id of VNF.  This is unique across the graph.
43017           required: true
43018           type: string
43019           example: __VNF-ID__
43020         - name: body
43021           in: body
43022           description: generic-vnf object that needs to be created or updated.
43023           required: true
43024           schema:
43025             $ref: "#/patchDefinitions/generic-vnf"
43026     delete:
43027       tags:
43028         - Network
43029       summary: delete an existing generic-vnf
43030       description: delete an existing generic-vnf
43031       operationId: deleteNetworkGenericVnfsGenericVnf
43032       consumes:
43033         - application/json
43034         - application/xml
43035       produces:
43036         - application/json
43037         - application/xml
43038       responses:
43039         "default":
43040           description: Response codes found in [response codes](https://wiki.onap.org/).
43041       parameters:
43042         - name: vnf-id
43043           in: path
43044           description: Unique id of VNF.  This is unique across the graph.
43045           required: true
43046           type: string
43047           example: __VNF-ID__
43048         - name: resource-version
43049           in: query
43050           description: resource-version for concurrency
43051           required: true
43052           type: string
43053   /network/generic-vnfs:
43054     get:
43055       tags:
43056         - Network
43057       summary: returns generic-vnfs
43058       description: returns generic-vnfs
43059       operationId: getNetworkGenericVnfs
43060       produces:
43061         - application/json
43062         - application/xml
43063       responses:
43064         "200":
43065           description: successful operation
43066           schema:
43067               $ref: "#/getDefinitions/generic-vnfs"
43068         "default":
43069           description: Response codes found in [response codes](https://wiki.onap.org/).
43070   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
43071     put:
43072       tags:
43073         - Network
43074       summary: see node definition for valid relationships
43075       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
43076       consumes:
43077         - application/json
43078         - application/xml
43079       produces:
43080         - application/json
43081         - application/xml
43082       responses:
43083         "default":
43084           description: Response codes found in [response codes](https://wiki.onap.org/).
43085       parameters:
43086         - name: link-name
43087           in: path
43088           description: Alphabetical concatenation of lag-interface names
43089           required: true
43090           type: string
43091           example: __LINK-NAME__
43092         - name: body
43093           in: body
43094           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
43095           required: true
43096           schema:
43097             $ref: "#/definitions/relationship"
43098     delete:
43099       tags:
43100         - Network
43101       summary: delete an existing relationship
43102       description: delete an existing relationship
43103       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
43104       consumes:
43105         - application/json
43106         - application/xml
43107       produces:
43108         - application/json
43109         - application/xml
43110       responses:
43111         "default":
43112           description: Response codes found in [response codes](https://wiki.onap.org/).
43113       parameters:
43114         - name: link-name
43115           in: path
43116           description: Alphabetical concatenation of lag-interface names
43117           required: true
43118           type: string
43119           example: __LINK-NAME__
43120   /network/lag-links/lag-link/{link-name}:
43121     get:
43122       tags:
43123         - Network
43124       summary: returns lag-link
43125       description: returns lag-link
43126       operationId: getNetworkLagLinksLagLink
43127       produces:
43128         - application/json
43129         - application/xml
43130       responses:
43131         "200":
43132           description: successful operation
43133           schema:
43134               $ref: "#/getDefinitions/lag-link"
43135         "default":
43136           description: Response codes found in [response codes](https://wiki.onap.org/).
43137       parameters:
43138         - name: link-name
43139           in: path
43140           description: Alphabetical concatenation of lag-interface names
43141           required: true
43142           type: string
43143           example: __LINK-NAME__
43144     put:
43145       tags:
43146         - Network
43147       summary: create or update an existing lag-link
43148       description: |
43149         Create or update an existing lag-link.
43150         #
43151         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
43152       operationId: createOrUpdateNetworkLagLinksLagLink
43153       consumes:
43154         - application/json
43155         - application/xml
43156       produces:
43157         - application/json
43158         - application/xml
43159       responses:
43160         "default":
43161           description: Response codes found in [response codes](https://wiki.onap.org/).
43162       parameters:
43163         - name: link-name
43164           in: path
43165           description: Alphabetical concatenation of lag-interface names
43166           required: true
43167           type: string
43168           example: __LINK-NAME__
43169         - name: body
43170           in: body
43171           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
43172           required: true
43173           schema:
43174             $ref: "#/definitions/lag-link"
43175     patch:
43176       tags:
43177         - Network
43178       summary: update an existing lag-link
43179       description: |
43180         Update an existing lag-link
43181         #
43182         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43183         The PUT operation will entirely replace an existing object.
43184         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.
43185         #
43186         Other differences between PUT and PATCH are:
43187         #
43188         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43189         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43190         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43191       operationId: UpdateNetworkLagLinksLagLink
43192       consumes:
43193         - application/json
43194         - application/xml
43195       produces:
43196         - application/json
43197         - application/xml
43198       responses:
43199         "default":
43200           description: Response codes found in [response codes](https://wiki.onap.org/).
43201       parameters:
43202         - name: link-name
43203           in: path
43204           description: Alphabetical concatenation of lag-interface names
43205           required: true
43206           type: string
43207           example: __LINK-NAME__
43208         - name: body
43209           in: body
43210           description: lag-link object that needs to be created or updated.
43211           required: true
43212           schema:
43213             $ref: "#/patchDefinitions/lag-link"
43214     delete:
43215       tags:
43216         - Network
43217       summary: delete an existing lag-link
43218       description: delete an existing lag-link
43219       operationId: deleteNetworkLagLinksLagLink
43220       consumes:
43221         - application/json
43222         - application/xml
43223       produces:
43224         - application/json
43225         - application/xml
43226       responses:
43227         "default":
43228           description: Response codes found in [response codes](https://wiki.onap.org/).
43229       parameters:
43230         - name: link-name
43231           in: path
43232           description: Alphabetical concatenation of lag-interface names
43233           required: true
43234           type: string
43235           example: __LINK-NAME__
43236         - name: resource-version
43237           in: query
43238           description: resource-version for concurrency
43239           required: true
43240           type: string
43241   /network/lag-links:
43242     get:
43243       tags:
43244         - Network
43245       summary: returns lag-links
43246       description: returns lag-links
43247       operationId: getNetworkLagLinks
43248       produces:
43249         - application/json
43250         - application/xml
43251       responses:
43252         "200":
43253           description: successful operation
43254           schema:
43255               $ref: "#/getDefinitions/lag-links"
43256         "default":
43257           description: Response codes found in [response codes](https://wiki.onap.org/).
43258   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
43259     put:
43260       tags:
43261         - Network
43262       summary: see node definition for valid relationships
43263       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
43264       consumes:
43265         - application/json
43266         - application/xml
43267       produces:
43268         - application/json
43269         - application/xml
43270       responses:
43271         "default":
43272           description: Response codes found in [response codes](https://wiki.onap.org/).
43273       parameters:
43274         - name: vnf-id2
43275           in: path
43276           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43277           required: true
43278           type: string
43279           example: __VNF-ID2__
43280         - name: body
43281           in: body
43282           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
43283           required: true
43284           schema:
43285             $ref: "#/definitions/relationship"
43286     delete:
43287       tags:
43288         - Network
43289       summary: delete an existing relationship
43290       description: delete an existing relationship
43291       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
43292       consumes:
43293         - application/json
43294         - application/xml
43295       produces:
43296         - application/json
43297         - application/xml
43298       responses:
43299         "default":
43300           description: Response codes found in [response codes](https://wiki.onap.org/).
43301       parameters:
43302         - name: vnf-id2
43303           in: path
43304           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43305           required: true
43306           type: string
43307           example: __VNF-ID2__
43308   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
43309     put:
43310       tags:
43311         - Network
43312       summary: see node definition for valid relationships
43313       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43314       consumes:
43315         - application/json
43316         - application/xml
43317       produces:
43318         - application/json
43319         - application/xml
43320       responses:
43321         "default":
43322           description: Response codes found in [response codes](https://wiki.onap.org/).
43323       parameters:
43324         - name: vnf-id2
43325           in: path
43326           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43327           required: true
43328           type: string
43329           example: __VNF-ID2__
43330         - name: interface-name
43331           in: path
43332           description: Name given to the interface
43333           required: true
43334           type: string
43335           example: __INTERFACE-NAME__
43336         - name: vlan-interface
43337           in: path
43338           description: String that identifies the interface
43339           required: true
43340           type: string
43341           example: __VLAN-INTERFACE__
43342         - name: body
43343           in: body
43344           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
43345           required: true
43346           schema:
43347             $ref: "#/definitions/relationship"
43348     delete:
43349       tags:
43350         - Network
43351       summary: delete an existing relationship
43352       description: delete an existing relationship
43353       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43354       consumes:
43355         - application/json
43356         - application/xml
43357       produces:
43358         - application/json
43359         - application/xml
43360       responses:
43361         "default":
43362           description: Response codes found in [response codes](https://wiki.onap.org/).
43363       parameters:
43364         - name: vnf-id2
43365           in: path
43366           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43367           required: true
43368           type: string
43369           example: __VNF-ID2__
43370         - name: interface-name
43371           in: path
43372           description: Name given to the interface
43373           required: true
43374           type: string
43375           example: __INTERFACE-NAME__
43376         - name: vlan-interface
43377           in: path
43378           description: String that identifies the interface
43379           required: true
43380           type: string
43381           example: __VLAN-INTERFACE__
43382   /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:
43383     put:
43384       tags:
43385         - Network
43386       summary: see node definition for valid relationships
43387       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43388       consumes:
43389         - application/json
43390         - application/xml
43391       produces:
43392         - application/json
43393         - application/xml
43394       responses:
43395         "default":
43396           description: Response codes found in [response codes](https://wiki.onap.org/).
43397       parameters:
43398         - name: vnf-id2
43399           in: path
43400           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43401           required: true
43402           type: string
43403           example: __VNF-ID2__
43404         - name: interface-name
43405           in: path
43406           description: Name given to the interface
43407           required: true
43408           type: string
43409           example: __INTERFACE-NAME__
43410         - name: vlan-interface
43411           in: path
43412           description: String that identifies the interface
43413           required: true
43414           type: string
43415           example: __VLAN-INTERFACE__
43416         - name: l3-interface-ipv4-address
43417           in: path
43418           description: IP address
43419           required: true
43420           type: string
43421           example: __L3-INTERFACE-IPV4-ADDRESS__
43422         - name: body
43423           in: body
43424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43425           required: true
43426           schema:
43427             $ref: "#/definitions/relationship"
43428     delete:
43429       tags:
43430         - Network
43431       summary: delete an existing relationship
43432       description: delete an existing relationship
43433       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43434       consumes:
43435         - application/json
43436         - application/xml
43437       produces:
43438         - application/json
43439         - application/xml
43440       responses:
43441         "default":
43442           description: Response codes found in [response codes](https://wiki.onap.org/).
43443       parameters:
43444         - name: vnf-id2
43445           in: path
43446           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43447           required: true
43448           type: string
43449           example: __VNF-ID2__
43450         - name: interface-name
43451           in: path
43452           description: Name given to the interface
43453           required: true
43454           type: string
43455           example: __INTERFACE-NAME__
43456         - name: vlan-interface
43457           in: path
43458           description: String that identifies the interface
43459           required: true
43460           type: string
43461           example: __VLAN-INTERFACE__
43462         - name: l3-interface-ipv4-address
43463           in: path
43464           description: IP address
43465           required: true
43466           type: string
43467           example: __L3-INTERFACE-IPV4-ADDRESS__
43468   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43469     get:
43470       tags:
43471         - Network
43472       summary: returns l3-interface-ipv4-address-list
43473       description: returns l3-interface-ipv4-address-list
43474       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43475       produces:
43476         - application/json
43477         - application/xml
43478       responses:
43479         "200":
43480           description: successful operation
43481           schema:
43482               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43483         "default":
43484           description: Response codes found in [response codes](https://wiki.onap.org/).
43485       parameters:
43486         - name: vnf-id2
43487           in: path
43488           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43489           required: true
43490           type: string
43491           example: __VNF-ID2__
43492         - name: interface-name
43493           in: path
43494           description: Name given to the interface
43495           required: true
43496           type: string
43497           example: __INTERFACE-NAME__
43498         - name: vlan-interface
43499           in: path
43500           description: String that identifies the interface
43501           required: true
43502           type: string
43503           example: __VLAN-INTERFACE__
43504         - name: l3-interface-ipv4-address
43505           in: path
43506           description: IP address
43507           required: true
43508           type: string
43509           example: __L3-INTERFACE-IPV4-ADDRESS__
43510         - name: vnf-name
43511           in: query
43512           description: Name of VNF.
43513           required: false
43514           type: string
43515         - name: vnf-name2
43516           in: query
43517           description: Alternate name of VNF.
43518           required: false
43519           type: string
43520         - name: vnf-type
43521           in: query
43522           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.
43523           required: false
43524           type: string
43525         - name: prov-status
43526           in: query
43527           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43528           required: false
43529           type: string
43530         - name: heat-stack-id
43531           in: query
43532           description: Heat stack id corresponding to this instance, managed by MSO
43533           required: false
43534           type: string
43535         - name: interface-id
43536           in: query
43537           description: ID of interface
43538           required: false
43539           type: string
43540         - name: macaddr
43541           in: query
43542           description: MAC address for the interface
43543           required: false
43544           type: string
43545         - name: network-name
43546           in: query
43547           description: Name of the network
43548           required: false
43549           type: string
43550         - name: vlan-id-inner
43551           in: query
43552           description: Inner VLAN tag
43553           required: false
43554           type: integer
43555           format: int64
43556         - name: vpn-key
43557           in: query
43558           description: This indicates the customers VPN ID associated with this vlan
43559           required: false
43560           type: string
43561         - name: vlan-id-inner
43562           in: query
43563           description: Inner VLAN tag
43564           required: false
43565           type: integer
43566           format: int64
43567         - name: neutron-network-id
43568           in: query
43569           description: Neutron network id of the interface that address belongs to
43570           required: false
43571           type: string
43572         - name: neutron-subnet-id
43573           in: query
43574           description: Neutron id of subnet that address belongs to
43575           required: false
43576           type: string
43577     put:
43578       tags:
43579         - Network
43580       summary: create or update an existing l3-interface-ipv4-address-list
43581       description: |
43582         Create or update an existing l3-interface-ipv4-address-list.
43583         #
43584         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
43585       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43586       consumes:
43587         - application/json
43588         - application/xml
43589       produces:
43590         - application/json
43591         - application/xml
43592       responses:
43593         "default":
43594           description: Response codes found in [response codes](https://wiki.onap.org/).
43595       parameters:
43596         - name: vnf-id2
43597           in: path
43598           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43599           required: true
43600           type: string
43601           example: __VNF-ID2__
43602         - name: interface-name
43603           in: path
43604           description: Name given to the interface
43605           required: true
43606           type: string
43607           example: __INTERFACE-NAME__
43608         - name: vlan-interface
43609           in: path
43610           description: String that identifies the interface
43611           required: true
43612           type: string
43613           example: __VLAN-INTERFACE__
43614         - name: l3-interface-ipv4-address
43615           in: path
43616           description: IP address
43617           required: true
43618           type: string
43619           example: __L3-INTERFACE-IPV4-ADDRESS__
43620         - name: body
43621           in: body
43622           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43623           required: true
43624           schema:
43625             $ref: "#/definitions/l3-interface-ipv4-address-list"
43626     patch:
43627       tags:
43628         - Network
43629       summary: update an existing l3-interface-ipv4-address-list
43630       description: |
43631         Update an existing l3-interface-ipv4-address-list
43632         #
43633         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43634         The PUT operation will entirely replace an existing object.
43635         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.
43636         #
43637         Other differences between PUT and PATCH are:
43638         #
43639         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43640         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43641         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43642       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43643       consumes:
43644         - application/json
43645         - application/xml
43646       produces:
43647         - application/json
43648         - application/xml
43649       responses:
43650         "default":
43651           description: Response codes found in [response codes](https://wiki.onap.org/).
43652       parameters:
43653         - name: vnf-id2
43654           in: path
43655           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43656           required: true
43657           type: string
43658           example: __VNF-ID2__
43659         - name: interface-name
43660           in: path
43661           description: Name given to the interface
43662           required: true
43663           type: string
43664           example: __INTERFACE-NAME__
43665         - name: vlan-interface
43666           in: path
43667           description: String that identifies the interface
43668           required: true
43669           type: string
43670           example: __VLAN-INTERFACE__
43671         - name: l3-interface-ipv4-address
43672           in: path
43673           description: IP address
43674           required: true
43675           type: string
43676           example: __L3-INTERFACE-IPV4-ADDRESS__
43677         - name: body
43678           in: body
43679           description: l3-interface-ipv4-address-list object that needs to be created or updated.
43680           required: true
43681           schema:
43682             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43683     delete:
43684       tags:
43685         - Network
43686       summary: delete an existing l3-interface-ipv4-address-list
43687       description: delete an existing l3-interface-ipv4-address-list
43688       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43689       consumes:
43690         - application/json
43691         - application/xml
43692       produces:
43693         - application/json
43694         - application/xml
43695       responses:
43696         "default":
43697           description: Response codes found in [response codes](https://wiki.onap.org/).
43698       parameters:
43699         - name: vnf-id2
43700           in: path
43701           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43702           required: true
43703           type: string
43704           example: __VNF-ID2__
43705         - name: interface-name
43706           in: path
43707           description: Name given to the interface
43708           required: true
43709           type: string
43710           example: __INTERFACE-NAME__
43711         - name: vlan-interface
43712           in: path
43713           description: String that identifies the interface
43714           required: true
43715           type: string
43716           example: __VLAN-INTERFACE__
43717         - name: l3-interface-ipv4-address
43718           in: path
43719           description: IP address
43720           required: true
43721           type: string
43722           example: __L3-INTERFACE-IPV4-ADDRESS__
43723         - name: resource-version
43724           in: query
43725           description: resource-version for concurrency
43726           required: true
43727           type: string
43728   /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:
43729     put:
43730       tags:
43731         - Network
43732       summary: see node definition for valid relationships
43733       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
43734       consumes:
43735         - application/json
43736         - application/xml
43737       produces:
43738         - application/json
43739         - application/xml
43740       responses:
43741         "default":
43742           description: Response codes found in [response codes](https://wiki.onap.org/).
43743       parameters:
43744         - name: vnf-id2
43745           in: path
43746           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43747           required: true
43748           type: string
43749           example: __VNF-ID2__
43750         - name: interface-name
43751           in: path
43752           description: Name given to the interface
43753           required: true
43754           type: string
43755           example: __INTERFACE-NAME__
43756         - name: vlan-interface
43757           in: path
43758           description: String that identifies the interface
43759           required: true
43760           type: string
43761           example: __VLAN-INTERFACE__
43762         - name: l3-interface-ipv6-address
43763           in: path
43764           description: IP address
43765           required: true
43766           type: string
43767           example: __L3-INTERFACE-IPV6-ADDRESS__
43768         - name: body
43769           in: body
43770           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
43771           required: true
43772           schema:
43773             $ref: "#/definitions/relationship"
43774     delete:
43775       tags:
43776         - Network
43777       summary: delete an existing relationship
43778       description: delete an existing relationship
43779       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
43780       consumes:
43781         - application/json
43782         - application/xml
43783       produces:
43784         - application/json
43785         - application/xml
43786       responses:
43787         "default":
43788           description: Response codes found in [response codes](https://wiki.onap.org/).
43789       parameters:
43790         - name: vnf-id2
43791           in: path
43792           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43793           required: true
43794           type: string
43795           example: __VNF-ID2__
43796         - name: interface-name
43797           in: path
43798           description: Name given to the interface
43799           required: true
43800           type: string
43801           example: __INTERFACE-NAME__
43802         - name: vlan-interface
43803           in: path
43804           description: String that identifies the interface
43805           required: true
43806           type: string
43807           example: __VLAN-INTERFACE__
43808         - name: l3-interface-ipv6-address
43809           in: path
43810           description: IP address
43811           required: true
43812           type: string
43813           example: __L3-INTERFACE-IPV6-ADDRESS__
43814   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
43815     get:
43816       tags:
43817         - Network
43818       summary: returns l3-interface-ipv6-address-list
43819       description: returns l3-interface-ipv6-address-list
43820       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43821       produces:
43822         - application/json
43823         - application/xml
43824       responses:
43825         "200":
43826           description: successful operation
43827           schema:
43828               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43829         "default":
43830           description: Response codes found in [response codes](https://wiki.onap.org/).
43831       parameters:
43832         - name: vnf-id2
43833           in: path
43834           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43835           required: true
43836           type: string
43837           example: __VNF-ID2__
43838         - name: interface-name
43839           in: path
43840           description: Name given to the interface
43841           required: true
43842           type: string
43843           example: __INTERFACE-NAME__
43844         - name: vlan-interface
43845           in: path
43846           description: String that identifies the interface
43847           required: true
43848           type: string
43849           example: __VLAN-INTERFACE__
43850         - name: l3-interface-ipv6-address
43851           in: path
43852           description: IP address
43853           required: true
43854           type: string
43855           example: __L3-INTERFACE-IPV6-ADDRESS__
43856         - name: vnf-name
43857           in: query
43858           description: Name of VNF.
43859           required: false
43860           type: string
43861         - name: vnf-name2
43862           in: query
43863           description: Alternate name of VNF.
43864           required: false
43865           type: string
43866         - name: vnf-type
43867           in: query
43868           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.
43869           required: false
43870           type: string
43871         - name: prov-status
43872           in: query
43873           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43874           required: false
43875           type: string
43876         - name: heat-stack-id
43877           in: query
43878           description: Heat stack id corresponding to this instance, managed by MSO
43879           required: false
43880           type: string
43881         - name: interface-id
43882           in: query
43883           description: ID of interface
43884           required: false
43885           type: string
43886         - name: macaddr
43887           in: query
43888           description: MAC address for the interface
43889           required: false
43890           type: string
43891         - name: network-name
43892           in: query
43893           description: Name of the network
43894           required: false
43895           type: string
43896         - name: vlan-id-inner
43897           in: query
43898           description: Inner VLAN tag
43899           required: false
43900           type: integer
43901           format: int64
43902         - name: vpn-key
43903           in: query
43904           description: This indicates the customers VPN ID associated with this vlan
43905           required: false
43906           type: string
43907         - name: vlan-id-inner
43908           in: query
43909           description: Inner VLAN tag
43910           required: false
43911           type: integer
43912           format: int64
43913         - name: neutron-network-id
43914           in: query
43915           description: Neutron network id of the interface that address belongs to
43916           required: false
43917           type: string
43918         - name: neutron-subnet-id
43919           in: query
43920           description: Neutron id of subnet that address belongs to
43921           required: false
43922           type: string
43923     put:
43924       tags:
43925         - Network
43926       summary: create or update an existing l3-interface-ipv6-address-list
43927       description: |
43928         Create or update an existing l3-interface-ipv6-address-list.
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: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: vnf-id2
43943           in: path
43944           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43945           required: true
43946           type: string
43947           example: __VNF-ID2__
43948         - name: interface-name
43949           in: path
43950           description: Name given to the interface
43951           required: true
43952           type: string
43953           example: __INTERFACE-NAME__
43954         - name: vlan-interface
43955           in: path
43956           description: String that identifies the interface
43957           required: true
43958           type: string
43959           example: __VLAN-INTERFACE__
43960         - name: l3-interface-ipv6-address
43961           in: path
43962           description: IP address
43963           required: true
43964           type: string
43965           example: __L3-INTERFACE-IPV6-ADDRESS__
43966         - name: body
43967           in: body
43968           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
43969           required: true
43970           schema:
43971             $ref: "#/definitions/l3-interface-ipv6-address-list"
43972     patch:
43973       tags:
43974         - Network
43975       summary: update an existing l3-interface-ipv6-address-list
43976       description: |
43977         Update an existing l3-interface-ipv6-address-list
43978         #
43979         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43980         The PUT operation will entirely replace an existing object.
43981         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.
43982         #
43983         Other differences between PUT and PATCH are:
43984         #
43985         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43986         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43987         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43988       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43989       consumes:
43990         - application/json
43991         - application/xml
43992       produces:
43993         - application/json
43994         - application/xml
43995       responses:
43996         "default":
43997           description: Response codes found in [response codes](https://wiki.onap.org/).
43998       parameters:
43999         - name: vnf-id2
44000           in: path
44001           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44002           required: true
44003           type: string
44004           example: __VNF-ID2__
44005         - name: interface-name
44006           in: path
44007           description: Name given to the interface
44008           required: true
44009           type: string
44010           example: __INTERFACE-NAME__
44011         - name: vlan-interface
44012           in: path
44013           description: String that identifies the interface
44014           required: true
44015           type: string
44016           example: __VLAN-INTERFACE__
44017         - name: l3-interface-ipv6-address
44018           in: path
44019           description: IP address
44020           required: true
44021           type: string
44022           example: __L3-INTERFACE-IPV6-ADDRESS__
44023         - name: body
44024           in: body
44025           description: l3-interface-ipv6-address-list object that needs to be created or updated.
44026           required: true
44027           schema:
44028             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44029     delete:
44030       tags:
44031         - Network
44032       summary: delete an existing l3-interface-ipv6-address-list
44033       description: delete an existing l3-interface-ipv6-address-list
44034       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44035       consumes:
44036         - application/json
44037         - application/xml
44038       produces:
44039         - application/json
44040         - application/xml
44041       responses:
44042         "default":
44043           description: Response codes found in [response codes](https://wiki.onap.org/).
44044       parameters:
44045         - name: vnf-id2
44046           in: path
44047           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44048           required: true
44049           type: string
44050           example: __VNF-ID2__
44051         - name: interface-name
44052           in: path
44053           description: Name given to the interface
44054           required: true
44055           type: string
44056           example: __INTERFACE-NAME__
44057         - name: vlan-interface
44058           in: path
44059           description: String that identifies the interface
44060           required: true
44061           type: string
44062           example: __VLAN-INTERFACE__
44063         - name: l3-interface-ipv6-address
44064           in: path
44065           description: IP address
44066           required: true
44067           type: string
44068           example: __L3-INTERFACE-IPV6-ADDRESS__
44069         - name: resource-version
44070           in: query
44071           description: resource-version for concurrency
44072           required: true
44073           type: string
44074   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
44075     get:
44076       tags:
44077         - Network
44078       summary: returns vlan
44079       description: returns vlan
44080       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44081       produces:
44082         - application/json
44083         - application/xml
44084       responses:
44085         "200":
44086           description: successful operation
44087           schema:
44088               $ref: "#/getDefinitions/vlan"
44089         "default":
44090           description: Response codes found in [response codes](https://wiki.onap.org/).
44091       parameters:
44092         - name: vnf-id2
44093           in: path
44094           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44095           required: true
44096           type: string
44097           example: __VNF-ID2__
44098         - name: interface-name
44099           in: path
44100           description: Name given to the interface
44101           required: true
44102           type: string
44103           example: __INTERFACE-NAME__
44104         - name: vlan-interface
44105           in: path
44106           description: String that identifies the interface
44107           required: true
44108           type: string
44109           example: __VLAN-INTERFACE__
44110         - name: vnf-name
44111           in: query
44112           description: Name of VNF.
44113           required: false
44114           type: string
44115         - name: vnf-name2
44116           in: query
44117           description: Alternate name of VNF.
44118           required: false
44119           type: string
44120         - name: vnf-type
44121           in: query
44122           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.
44123           required: false
44124           type: string
44125         - name: prov-status
44126           in: query
44127           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44128           required: false
44129           type: string
44130         - name: heat-stack-id
44131           in: query
44132           description: Heat stack id corresponding to this instance, managed by MSO
44133           required: false
44134           type: string
44135         - name: interface-id
44136           in: query
44137           description: ID of interface
44138           required: false
44139           type: string
44140         - name: macaddr
44141           in: query
44142           description: MAC address for the interface
44143           required: false
44144           type: string
44145         - name: network-name
44146           in: query
44147           description: Name of the network
44148           required: false
44149           type: string
44150         - name: vlan-id-inner
44151           in: query
44152           description: Inner VLAN tag
44153           required: false
44154           type: integer
44155           format: int64
44156         - name: vpn-key
44157           in: query
44158           description: This indicates the customers VPN ID associated with this vlan
44159           required: false
44160           type: string
44161     put:
44162       tags:
44163         - Network
44164       summary: create or update an existing vlan
44165       description: |
44166         Create or update an existing vlan.
44167         #
44168         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
44169       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44170       consumes:
44171         - application/json
44172         - application/xml
44173       produces:
44174         - application/json
44175         - application/xml
44176       responses:
44177         "default":
44178           description: Response codes found in [response codes](https://wiki.onap.org/).
44179       parameters:
44180         - name: vnf-id2
44181           in: path
44182           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44183           required: true
44184           type: string
44185           example: __VNF-ID2__
44186         - name: interface-name
44187           in: path
44188           description: Name given to the interface
44189           required: true
44190           type: string
44191           example: __INTERFACE-NAME__
44192         - name: vlan-interface
44193           in: path
44194           description: String that identifies the interface
44195           required: true
44196           type: string
44197           example: __VLAN-INTERFACE__
44198         - name: body
44199           in: body
44200           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
44201           required: true
44202           schema:
44203             $ref: "#/definitions/vlan"
44204     patch:
44205       tags:
44206         - Network
44207       summary: update an existing vlan
44208       description: |
44209         Update an existing vlan
44210         #
44211         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44212         The PUT operation will entirely replace an existing object.
44213         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.
44214         #
44215         Other differences between PUT and PATCH are:
44216         #
44217         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44218         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44219         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44220       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44221       consumes:
44222         - application/json
44223         - application/xml
44224       produces:
44225         - application/json
44226         - application/xml
44227       responses:
44228         "default":
44229           description: Response codes found in [response codes](https://wiki.onap.org/).
44230       parameters:
44231         - name: vnf-id2
44232           in: path
44233           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44234           required: true
44235           type: string
44236           example: __VNF-ID2__
44237         - name: interface-name
44238           in: path
44239           description: Name given to the interface
44240           required: true
44241           type: string
44242           example: __INTERFACE-NAME__
44243         - name: vlan-interface
44244           in: path
44245           description: String that identifies the interface
44246           required: true
44247           type: string
44248           example: __VLAN-INTERFACE__
44249         - name: body
44250           in: body
44251           description: vlan object that needs to be created or updated.
44252           required: true
44253           schema:
44254             $ref: "#/patchDefinitions/vlan"
44255     delete:
44256       tags:
44257         - Network
44258       summary: delete an existing vlan
44259       description: delete an existing vlan
44260       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
44261       consumes:
44262         - application/json
44263         - application/xml
44264       produces:
44265         - application/json
44266         - application/xml
44267       responses:
44268         "default":
44269           description: Response codes found in [response codes](https://wiki.onap.org/).
44270       parameters:
44271         - name: vnf-id2
44272           in: path
44273           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44274           required: true
44275           type: string
44276           example: __VNF-ID2__
44277         - name: interface-name
44278           in: path
44279           description: Name given to the interface
44280           required: true
44281           type: string
44282           example: __INTERFACE-NAME__
44283         - name: vlan-interface
44284           in: path
44285           description: String that identifies the interface
44286           required: true
44287           type: string
44288           example: __VLAN-INTERFACE__
44289         - name: resource-version
44290           in: query
44291           description: resource-version for concurrency
44292           required: true
44293           type: string
44294   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
44295     get:
44296       tags:
44297         - Network
44298       summary: returns vlans
44299       description: returns vlans
44300       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
44301       produces:
44302         - application/json
44303         - application/xml
44304       responses:
44305         "200":
44306           description: successful operation
44307           schema:
44308               $ref: "#/getDefinitions/vlans"
44309         "default":
44310           description: Response codes found in [response codes](https://wiki.onap.org/).
44311       parameters:
44312         - name: vnf-id2
44313           in: path
44314           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44315           required: true
44316           type: string
44317           example: __VNF-ID2__
44318         - name: interface-name
44319           in: path
44320           description: Name given to the interface
44321           required: true
44322           type: string
44323           example: __INTERFACE-NAME__
44324         - name: vnf-name
44325           in: query
44326           description: Name of VNF.
44327           required: false
44328           type: string
44329         - name: vnf-name2
44330           in: query
44331           description: Alternate name of VNF.
44332           required: false
44333           type: string
44334         - name: vnf-type
44335           in: query
44336           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.
44337           required: false
44338           type: string
44339         - name: prov-status
44340           in: query
44341           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44342           required: false
44343           type: string
44344         - name: heat-stack-id
44345           in: query
44346           description: Heat stack id corresponding to this instance, managed by MSO
44347           required: false
44348           type: string
44349         - name: interface-id
44350           in: query
44351           description: ID of interface
44352           required: false
44353           type: string
44354         - name: macaddr
44355           in: query
44356           description: MAC address for the interface
44357           required: false
44358           type: string
44359         - name: network-name
44360           in: query
44361           description: Name of the network
44362           required: false
44363           type: string
44364   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
44365     put:
44366       tags:
44367         - Network
44368       summary: see node definition for valid relationships
44369       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44370       consumes:
44371         - application/json
44372         - application/xml
44373       produces:
44374         - application/json
44375         - application/xml
44376       responses:
44377         "default":
44378           description: Response codes found in [response codes](https://wiki.onap.org/).
44379       parameters:
44380         - name: vnf-id2
44381           in: path
44382           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44383           required: true
44384           type: string
44385           example: __VNF-ID2__
44386         - name: interface-name
44387           in: path
44388           description: Name given to the interface
44389           required: true
44390           type: string
44391           example: __INTERFACE-NAME__
44392         - name: pci-id
44393           in: path
44394           description: PCI ID used to identify the sriov-vf
44395           required: true
44396           type: string
44397           example: __PCI-ID__
44398         - name: body
44399           in: body
44400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
44401           required: true
44402           schema:
44403             $ref: "#/definitions/relationship"
44404     delete:
44405       tags:
44406         - Network
44407       summary: delete an existing relationship
44408       description: delete an existing relationship
44409       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44410       consumes:
44411         - application/json
44412         - application/xml
44413       produces:
44414         - application/json
44415         - application/xml
44416       responses:
44417         "default":
44418           description: Response codes found in [response codes](https://wiki.onap.org/).
44419       parameters:
44420         - name: vnf-id2
44421           in: path
44422           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44423           required: true
44424           type: string
44425           example: __VNF-ID2__
44426         - name: interface-name
44427           in: path
44428           description: Name given to the interface
44429           required: true
44430           type: string
44431           example: __INTERFACE-NAME__
44432         - name: pci-id
44433           in: path
44434           description: PCI ID used to identify the sriov-vf
44435           required: true
44436           type: string
44437           example: __PCI-ID__
44438   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
44439     get:
44440       tags:
44441         - Network
44442       summary: returns sriov-vf
44443       description: returns sriov-vf
44444       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44445       produces:
44446         - application/json
44447         - application/xml
44448       responses:
44449         "200":
44450           description: successful operation
44451           schema:
44452               $ref: "#/getDefinitions/sriov-vf"
44453         "default":
44454           description: Response codes found in [response codes](https://wiki.onap.org/).
44455       parameters:
44456         - name: vnf-id2
44457           in: path
44458           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44459           required: true
44460           type: string
44461           example: __VNF-ID2__
44462         - name: interface-name
44463           in: path
44464           description: Name given to the interface
44465           required: true
44466           type: string
44467           example: __INTERFACE-NAME__
44468         - name: pci-id
44469           in: path
44470           description: PCI ID used to identify the sriov-vf
44471           required: true
44472           type: string
44473           example: __PCI-ID__
44474         - name: vnf-name
44475           in: query
44476           description: Name of VNF.
44477           required: false
44478           type: string
44479         - name: vnf-name2
44480           in: query
44481           description: Alternate name of VNF.
44482           required: false
44483           type: string
44484         - name: vnf-type
44485           in: query
44486           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.
44487           required: false
44488           type: string
44489         - name: prov-status
44490           in: query
44491           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44492           required: false
44493           type: string
44494         - name: heat-stack-id
44495           in: query
44496           description: Heat stack id corresponding to this instance, managed by MSO
44497           required: false
44498           type: string
44499         - name: interface-id
44500           in: query
44501           description: ID of interface
44502           required: false
44503           type: string
44504         - name: macaddr
44505           in: query
44506           description: MAC address for the interface
44507           required: false
44508           type: string
44509         - name: network-name
44510           in: query
44511           description: Name of the network
44512           required: false
44513           type: string
44514         - name: vf-vlan-filter
44515           in: query
44516           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
44517           required: false
44518           type: string
44519         - name: vf-mac-filter
44520           in: query
44521           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
44522           required: false
44523           type: string
44524         - name: vf-vlan-strip
44525           in: query
44526           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
44527           required: false
44528           type: boolean
44529         - name: neutron-network-id
44530           in: query
44531           description: Neutron network id of the interface
44532           required: false
44533           type: string
44534     put:
44535       tags:
44536         - Network
44537       summary: create or update an existing sriov-vf
44538       description: |
44539         Create or update an existing sriov-vf.
44540         #
44541         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
44542       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44543       consumes:
44544         - application/json
44545         - application/xml
44546       produces:
44547         - application/json
44548         - application/xml
44549       responses:
44550         "default":
44551           description: Response codes found in [response codes](https://wiki.onap.org/).
44552       parameters:
44553         - name: vnf-id2
44554           in: path
44555           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44556           required: true
44557           type: string
44558           example: __VNF-ID2__
44559         - name: interface-name
44560           in: path
44561           description: Name given to the interface
44562           required: true
44563           type: string
44564           example: __INTERFACE-NAME__
44565         - name: pci-id
44566           in: path
44567           description: PCI ID used to identify the sriov-vf
44568           required: true
44569           type: string
44570           example: __PCI-ID__
44571         - name: body
44572           in: body
44573           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
44574           required: true
44575           schema:
44576             $ref: "#/definitions/sriov-vf"
44577     patch:
44578       tags:
44579         - Network
44580       summary: update an existing sriov-vf
44581       description: |
44582         Update an existing sriov-vf
44583         #
44584         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44585         The PUT operation will entirely replace an existing object.
44586         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.
44587         #
44588         Other differences between PUT and PATCH are:
44589         #
44590         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44591         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44592         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44593       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44594       consumes:
44595         - application/json
44596         - application/xml
44597       produces:
44598         - application/json
44599         - application/xml
44600       responses:
44601         "default":
44602           description: Response codes found in [response codes](https://wiki.onap.org/).
44603       parameters:
44604         - name: vnf-id2
44605           in: path
44606           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44607           required: true
44608           type: string
44609           example: __VNF-ID2__
44610         - name: interface-name
44611           in: path
44612           description: Name given to the interface
44613           required: true
44614           type: string
44615           example: __INTERFACE-NAME__
44616         - name: pci-id
44617           in: path
44618           description: PCI ID used to identify the sriov-vf
44619           required: true
44620           type: string
44621           example: __PCI-ID__
44622         - name: body
44623           in: body
44624           description: sriov-vf object that needs to be created or updated.
44625           required: true
44626           schema:
44627             $ref: "#/patchDefinitions/sriov-vf"
44628     delete:
44629       tags:
44630         - Network
44631       summary: delete an existing sriov-vf
44632       description: delete an existing sriov-vf
44633       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
44634       consumes:
44635         - application/json
44636         - application/xml
44637       produces:
44638         - application/json
44639         - application/xml
44640       responses:
44641         "default":
44642           description: Response codes found in [response codes](https://wiki.onap.org/).
44643       parameters:
44644         - name: vnf-id2
44645           in: path
44646           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44647           required: true
44648           type: string
44649           example: __VNF-ID2__
44650         - name: interface-name
44651           in: path
44652           description: Name given to the interface
44653           required: true
44654           type: string
44655           example: __INTERFACE-NAME__
44656         - name: pci-id
44657           in: path
44658           description: PCI ID used to identify the sriov-vf
44659           required: true
44660           type: string
44661           example: __PCI-ID__
44662         - name: resource-version
44663           in: query
44664           description: resource-version for concurrency
44665           required: true
44666           type: string
44667   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
44668     get:
44669       tags:
44670         - Network
44671       summary: returns sriov-vfs
44672       description: returns sriov-vfs
44673       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
44674       produces:
44675         - application/json
44676         - application/xml
44677       responses:
44678         "200":
44679           description: successful operation
44680           schema:
44681               $ref: "#/getDefinitions/sriov-vfs"
44682         "default":
44683           description: Response codes found in [response codes](https://wiki.onap.org/).
44684       parameters:
44685         - name: vnf-id2
44686           in: path
44687           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44688           required: true
44689           type: string
44690           example: __VNF-ID2__
44691         - name: interface-name
44692           in: path
44693           description: Name given to the interface
44694           required: true
44695           type: string
44696           example: __INTERFACE-NAME__
44697         - name: vnf-name
44698           in: query
44699           description: Name of VNF.
44700           required: false
44701           type: string
44702         - name: vnf-name2
44703           in: query
44704           description: Alternate name of VNF.
44705           required: false
44706           type: string
44707         - name: vnf-type
44708           in: query
44709           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.
44710           required: false
44711           type: string
44712         - name: prov-status
44713           in: query
44714           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44715           required: false
44716           type: string
44717         - name: heat-stack-id
44718           in: query
44719           description: Heat stack id corresponding to this instance, managed by MSO
44720           required: false
44721           type: string
44722         - name: interface-id
44723           in: query
44724           description: ID of interface
44725           required: false
44726           type: string
44727         - name: macaddr
44728           in: query
44729           description: MAC address for the interface
44730           required: false
44731           type: string
44732         - name: network-name
44733           in: query
44734           description: Name of the network
44735           required: false
44736           type: string
44737   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
44738     put:
44739       tags:
44740         - Network
44741       summary: see node definition for valid relationships
44742       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
44743       consumes:
44744         - application/json
44745         - application/xml
44746       produces:
44747         - application/json
44748         - application/xml
44749       responses:
44750         "default":
44751           description: Response codes found in [response codes](https://wiki.onap.org/).
44752       parameters:
44753         - name: vnf-id2
44754           in: path
44755           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44756           required: true
44757           type: string
44758           example: __VNF-ID2__
44759         - name: interface-name
44760           in: path
44761           description: Name given to the interface
44762           required: true
44763           type: string
44764           example: __INTERFACE-NAME__
44765         - name: body
44766           in: body
44767           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
44768           required: true
44769           schema:
44770             $ref: "#/definitions/relationship"
44771     delete:
44772       tags:
44773         - Network
44774       summary: delete an existing relationship
44775       description: delete an existing relationship
44776       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
44777       consumes:
44778         - application/json
44779         - application/xml
44780       produces:
44781         - application/json
44782         - application/xml
44783       responses:
44784         "default":
44785           description: Response codes found in [response codes](https://wiki.onap.org/).
44786       parameters:
44787         - name: vnf-id2
44788           in: path
44789           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44790           required: true
44791           type: string
44792           example: __VNF-ID2__
44793         - name: interface-name
44794           in: path
44795           description: Name given to the interface
44796           required: true
44797           type: string
44798           example: __INTERFACE-NAME__
44799   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
44800     put:
44801       tags:
44802         - Network
44803       summary: see node definition for valid relationships
44804       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
44805       consumes:
44806         - application/json
44807         - application/xml
44808       produces:
44809         - application/json
44810         - application/xml
44811       responses:
44812         "default":
44813           description: Response codes found in [response codes](https://wiki.onap.org/).
44814       parameters:
44815         - name: vnf-id2
44816           in: path
44817           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44818           required: true
44819           type: string
44820           example: __VNF-ID2__
44821         - name: interface-name
44822           in: path
44823           description: Name given to the interface
44824           required: true
44825           type: string
44826           example: __INTERFACE-NAME__
44827         - name: l3-interface-ipv4-address
44828           in: path
44829           description: IP address
44830           required: true
44831           type: string
44832           example: __L3-INTERFACE-IPV4-ADDRESS__
44833         - name: body
44834           in: body
44835           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
44836           required: true
44837           schema:
44838             $ref: "#/definitions/relationship"
44839     delete:
44840       tags:
44841         - Network
44842       summary: delete an existing relationship
44843       description: delete an existing relationship
44844       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
44845       consumes:
44846         - application/json
44847         - application/xml
44848       produces:
44849         - application/json
44850         - application/xml
44851       responses:
44852         "default":
44853           description: Response codes found in [response codes](https://wiki.onap.org/).
44854       parameters:
44855         - name: vnf-id2
44856           in: path
44857           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44858           required: true
44859           type: string
44860           example: __VNF-ID2__
44861         - name: interface-name
44862           in: path
44863           description: Name given to the interface
44864           required: true
44865           type: string
44866           example: __INTERFACE-NAME__
44867         - name: l3-interface-ipv4-address
44868           in: path
44869           description: IP address
44870           required: true
44871           type: string
44872           example: __L3-INTERFACE-IPV4-ADDRESS__
44873   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
44874     get:
44875       tags:
44876         - Network
44877       summary: returns l3-interface-ipv4-address-list
44878       description: returns l3-interface-ipv4-address-list
44879       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44880       produces:
44881         - application/json
44882         - application/xml
44883       responses:
44884         "200":
44885           description: successful operation
44886           schema:
44887               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
44888         "default":
44889           description: Response codes found in [response codes](https://wiki.onap.org/).
44890       parameters:
44891         - name: vnf-id2
44892           in: path
44893           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44894           required: true
44895           type: string
44896           example: __VNF-ID2__
44897         - name: interface-name
44898           in: path
44899           description: Name given to the interface
44900           required: true
44901           type: string
44902           example: __INTERFACE-NAME__
44903         - name: l3-interface-ipv4-address
44904           in: path
44905           description: IP address
44906           required: true
44907           type: string
44908           example: __L3-INTERFACE-IPV4-ADDRESS__
44909         - name: vnf-name
44910           in: query
44911           description: Name of VNF.
44912           required: false
44913           type: string
44914         - name: vnf-name2
44915           in: query
44916           description: Alternate name of VNF.
44917           required: false
44918           type: string
44919         - name: vnf-type
44920           in: query
44921           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.
44922           required: false
44923           type: string
44924         - name: prov-status
44925           in: query
44926           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44927           required: false
44928           type: string
44929         - name: heat-stack-id
44930           in: query
44931           description: Heat stack id corresponding to this instance, managed by MSO
44932           required: false
44933           type: string
44934         - name: interface-id
44935           in: query
44936           description: ID of interface
44937           required: false
44938           type: string
44939         - name: macaddr
44940           in: query
44941           description: MAC address for the interface
44942           required: false
44943           type: string
44944         - name: network-name
44945           in: query
44946           description: Name of the network
44947           required: false
44948           type: string
44949         - name: vlan-id-inner
44950           in: query
44951           description: Inner VLAN tag
44952           required: false
44953           type: integer
44954           format: int64
44955         - name: neutron-network-id
44956           in: query
44957           description: Neutron network id of the interface that address belongs to
44958           required: false
44959           type: string
44960         - name: neutron-subnet-id
44961           in: query
44962           description: Neutron id of subnet that address belongs to
44963           required: false
44964           type: string
44965     put:
44966       tags:
44967         - Network
44968       summary: create or update an existing l3-interface-ipv4-address-list
44969       description: |
44970         Create or update an existing l3-interface-ipv4-address-list.
44971         #
44972         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
44973       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44974       consumes:
44975         - application/json
44976         - application/xml
44977       produces:
44978         - application/json
44979         - application/xml
44980       responses:
44981         "default":
44982           description: Response codes found in [response codes](https://wiki.onap.org/).
44983       parameters:
44984         - name: vnf-id2
44985           in: path
44986           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44987           required: true
44988           type: string
44989           example: __VNF-ID2__
44990         - name: interface-name
44991           in: path
44992           description: Name given to the interface
44993           required: true
44994           type: string
44995           example: __INTERFACE-NAME__
44996         - name: l3-interface-ipv4-address
44997           in: path
44998           description: IP address
44999           required: true
45000           type: string
45001           example: __L3-INTERFACE-IPV4-ADDRESS__
45002         - name: body
45003           in: body
45004           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45005           required: true
45006           schema:
45007             $ref: "#/definitions/l3-interface-ipv4-address-list"
45008     patch:
45009       tags:
45010         - Network
45011       summary: update an existing l3-interface-ipv4-address-list
45012       description: |
45013         Update an existing l3-interface-ipv4-address-list
45014         #
45015         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45016         The PUT operation will entirely replace an existing object.
45017         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.
45018         #
45019         Other differences between PUT and PATCH are:
45020         #
45021         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45022         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45023         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45024       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45025       consumes:
45026         - application/json
45027         - application/xml
45028       produces:
45029         - application/json
45030         - application/xml
45031       responses:
45032         "default":
45033           description: Response codes found in [response codes](https://wiki.onap.org/).
45034       parameters:
45035         - name: vnf-id2
45036           in: path
45037           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45038           required: true
45039           type: string
45040           example: __VNF-ID2__
45041         - name: interface-name
45042           in: path
45043           description: Name given to the interface
45044           required: true
45045           type: string
45046           example: __INTERFACE-NAME__
45047         - name: l3-interface-ipv4-address
45048           in: path
45049           description: IP address
45050           required: true
45051           type: string
45052           example: __L3-INTERFACE-IPV4-ADDRESS__
45053         - name: body
45054           in: body
45055           description: l3-interface-ipv4-address-list object that needs to be created or updated.
45056           required: true
45057           schema:
45058             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45059     delete:
45060       tags:
45061         - Network
45062       summary: delete an existing l3-interface-ipv4-address-list
45063       description: delete an existing l3-interface-ipv4-address-list
45064       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45065       consumes:
45066         - application/json
45067         - application/xml
45068       produces:
45069         - application/json
45070         - application/xml
45071       responses:
45072         "default":
45073           description: Response codes found in [response codes](https://wiki.onap.org/).
45074       parameters:
45075         - name: vnf-id2
45076           in: path
45077           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45078           required: true
45079           type: string
45080           example: __VNF-ID2__
45081         - name: interface-name
45082           in: path
45083           description: Name given to the interface
45084           required: true
45085           type: string
45086           example: __INTERFACE-NAME__
45087         - name: l3-interface-ipv4-address
45088           in: path
45089           description: IP address
45090           required: true
45091           type: string
45092           example: __L3-INTERFACE-IPV4-ADDRESS__
45093         - name: resource-version
45094           in: query
45095           description: resource-version for concurrency
45096           required: true
45097           type: string
45098   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
45099     put:
45100       tags:
45101         - Network
45102       summary: see node definition for valid relationships
45103       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45104       consumes:
45105         - application/json
45106         - application/xml
45107       produces:
45108         - application/json
45109         - application/xml
45110       responses:
45111         "default":
45112           description: Response codes found in [response codes](https://wiki.onap.org/).
45113       parameters:
45114         - name: vnf-id2
45115           in: path
45116           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45117           required: true
45118           type: string
45119           example: __VNF-ID2__
45120         - name: interface-name
45121           in: path
45122           description: Name given to the interface
45123           required: true
45124           type: string
45125           example: __INTERFACE-NAME__
45126         - name: l3-interface-ipv6-address
45127           in: path
45128           description: IP address
45129           required: true
45130           type: string
45131           example: __L3-INTERFACE-IPV6-ADDRESS__
45132         - name: body
45133           in: body
45134           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45135           required: true
45136           schema:
45137             $ref: "#/definitions/relationship"
45138     delete:
45139       tags:
45140         - Network
45141       summary: delete an existing relationship
45142       description: delete an existing relationship
45143       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45144       consumes:
45145         - application/json
45146         - application/xml
45147       produces:
45148         - application/json
45149         - application/xml
45150       responses:
45151         "default":
45152           description: Response codes found in [response codes](https://wiki.onap.org/).
45153       parameters:
45154         - name: vnf-id2
45155           in: path
45156           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45157           required: true
45158           type: string
45159           example: __VNF-ID2__
45160         - name: interface-name
45161           in: path
45162           description: Name given to the interface
45163           required: true
45164           type: string
45165           example: __INTERFACE-NAME__
45166         - name: l3-interface-ipv6-address
45167           in: path
45168           description: IP address
45169           required: true
45170           type: string
45171           example: __L3-INTERFACE-IPV6-ADDRESS__
45172   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
45173     get:
45174       tags:
45175         - Network
45176       summary: returns l3-interface-ipv6-address-list
45177       description: returns l3-interface-ipv6-address-list
45178       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45179       produces:
45180         - application/json
45181         - application/xml
45182       responses:
45183         "200":
45184           description: successful operation
45185           schema:
45186               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45187         "default":
45188           description: Response codes found in [response codes](https://wiki.onap.org/).
45189       parameters:
45190         - name: vnf-id2
45191           in: path
45192           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45193           required: true
45194           type: string
45195           example: __VNF-ID2__
45196         - name: interface-name
45197           in: path
45198           description: Name given to the interface
45199           required: true
45200           type: string
45201           example: __INTERFACE-NAME__
45202         - name: l3-interface-ipv6-address
45203           in: path
45204           description: IP address
45205           required: true
45206           type: string
45207           example: __L3-INTERFACE-IPV6-ADDRESS__
45208         - name: vnf-name
45209           in: query
45210           description: Name of VNF.
45211           required: false
45212           type: string
45213         - name: vnf-name2
45214           in: query
45215           description: Alternate name of VNF.
45216           required: false
45217           type: string
45218         - name: vnf-type
45219           in: query
45220           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.
45221           required: false
45222           type: string
45223         - name: prov-status
45224           in: query
45225           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45226           required: false
45227           type: string
45228         - name: heat-stack-id
45229           in: query
45230           description: Heat stack id corresponding to this instance, managed by MSO
45231           required: false
45232           type: string
45233         - name: interface-id
45234           in: query
45235           description: ID of interface
45236           required: false
45237           type: string
45238         - name: macaddr
45239           in: query
45240           description: MAC address for the interface
45241           required: false
45242           type: string
45243         - name: network-name
45244           in: query
45245           description: Name of the network
45246           required: false
45247           type: string
45248         - name: vlan-id-inner
45249           in: query
45250           description: Inner VLAN tag
45251           required: false
45252           type: integer
45253           format: int64
45254         - name: neutron-network-id
45255           in: query
45256           description: Neutron network id of the interface that address belongs to
45257           required: false
45258           type: string
45259         - name: neutron-subnet-id
45260           in: query
45261           description: Neutron id of subnet that address belongs to
45262           required: false
45263           type: string
45264     put:
45265       tags:
45266         - Network
45267       summary: create or update an existing l3-interface-ipv6-address-list
45268       description: |
45269         Create or update an existing l3-interface-ipv6-address-list.
45270         #
45271         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
45272       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45273       consumes:
45274         - application/json
45275         - application/xml
45276       produces:
45277         - application/json
45278         - application/xml
45279       responses:
45280         "default":
45281           description: Response codes found in [response codes](https://wiki.onap.org/).
45282       parameters:
45283         - name: vnf-id2
45284           in: path
45285           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45286           required: true
45287           type: string
45288           example: __VNF-ID2__
45289         - name: interface-name
45290           in: path
45291           description: Name given to the interface
45292           required: true
45293           type: string
45294           example: __INTERFACE-NAME__
45295         - name: l3-interface-ipv6-address
45296           in: path
45297           description: IP address
45298           required: true
45299           type: string
45300           example: __L3-INTERFACE-IPV6-ADDRESS__
45301         - name: body
45302           in: body
45303           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45304           required: true
45305           schema:
45306             $ref: "#/definitions/l3-interface-ipv6-address-list"
45307     patch:
45308       tags:
45309         - Network
45310       summary: update an existing l3-interface-ipv6-address-list
45311       description: |
45312         Update an existing l3-interface-ipv6-address-list
45313         #
45314         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45315         The PUT operation will entirely replace an existing object.
45316         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.
45317         #
45318         Other differences between PUT and PATCH are:
45319         #
45320         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45321         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45322         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45323       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45324       consumes:
45325         - application/json
45326         - application/xml
45327       produces:
45328         - application/json
45329         - application/xml
45330       responses:
45331         "default":
45332           description: Response codes found in [response codes](https://wiki.onap.org/).
45333       parameters:
45334         - name: vnf-id2
45335           in: path
45336           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45337           required: true
45338           type: string
45339           example: __VNF-ID2__
45340         - name: interface-name
45341           in: path
45342           description: Name given to the interface
45343           required: true
45344           type: string
45345           example: __INTERFACE-NAME__
45346         - name: l3-interface-ipv6-address
45347           in: path
45348           description: IP address
45349           required: true
45350           type: string
45351           example: __L3-INTERFACE-IPV6-ADDRESS__
45352         - name: body
45353           in: body
45354           description: l3-interface-ipv6-address-list object that needs to be created or updated.
45355           required: true
45356           schema:
45357             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
45358     delete:
45359       tags:
45360         - Network
45361       summary: delete an existing l3-interface-ipv6-address-list
45362       description: delete an existing l3-interface-ipv6-address-list
45363       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45364       consumes:
45365         - application/json
45366         - application/xml
45367       produces:
45368         - application/json
45369         - application/xml
45370       responses:
45371         "default":
45372           description: Response codes found in [response codes](https://wiki.onap.org/).
45373       parameters:
45374         - name: vnf-id2
45375           in: path
45376           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45377           required: true
45378           type: string
45379           example: __VNF-ID2__
45380         - name: interface-name
45381           in: path
45382           description: Name given to the interface
45383           required: true
45384           type: string
45385           example: __INTERFACE-NAME__
45386         - name: l3-interface-ipv6-address
45387           in: path
45388           description: IP address
45389           required: true
45390           type: string
45391           example: __L3-INTERFACE-IPV6-ADDRESS__
45392         - name: resource-version
45393           in: query
45394           description: resource-version for concurrency
45395           required: true
45396           type: string
45397   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
45398     get:
45399       tags:
45400         - Network
45401       summary: returns l-interface
45402       description: returns l-interface
45403       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
45404       produces:
45405         - application/json
45406         - application/xml
45407       responses:
45408         "200":
45409           description: successful operation
45410           schema:
45411               $ref: "#/getDefinitions/l-interface"
45412         "default":
45413           description: Response codes found in [response codes](https://wiki.onap.org/).
45414       parameters:
45415         - name: vnf-id2
45416           in: path
45417           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45418           required: true
45419           type: string
45420           example: __VNF-ID2__
45421         - name: interface-name
45422           in: path
45423           description: Name given to the interface
45424           required: true
45425           type: string
45426           example: __INTERFACE-NAME__
45427         - name: vnf-name
45428           in: query
45429           description: Name of VNF.
45430           required: false
45431           type: string
45432         - name: vnf-name2
45433           in: query
45434           description: Alternate name of VNF.
45435           required: false
45436           type: string
45437         - name: vnf-type
45438           in: query
45439           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.
45440           required: false
45441           type: string
45442         - name: prov-status
45443           in: query
45444           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45445           required: false
45446           type: string
45447         - name: heat-stack-id
45448           in: query
45449           description: Heat stack id corresponding to this instance, managed by MSO
45450           required: false
45451           type: string
45452         - name: interface-id
45453           in: query
45454           description: ID of interface
45455           required: false
45456           type: string
45457         - name: macaddr
45458           in: query
45459           description: MAC address for the interface
45460           required: false
45461           type: string
45462         - name: network-name
45463           in: query
45464           description: Name of the network
45465           required: false
45466           type: string
45467     put:
45468       tags:
45469         - Network
45470       summary: create or update an existing l-interface
45471       description: |
45472         Create or update an existing l-interface.
45473         #
45474         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
45475       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
45476       consumes:
45477         - application/json
45478         - application/xml
45479       produces:
45480         - application/json
45481         - application/xml
45482       responses:
45483         "default":
45484           description: Response codes found in [response codes](https://wiki.onap.org/).
45485       parameters:
45486         - name: vnf-id2
45487           in: path
45488           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45489           required: true
45490           type: string
45491           example: __VNF-ID2__
45492         - name: interface-name
45493           in: path
45494           description: Name given to the interface
45495           required: true
45496           type: string
45497           example: __INTERFACE-NAME__
45498         - name: body
45499           in: body
45500           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
45501           required: true
45502           schema:
45503             $ref: "#/definitions/l-interface"
45504     patch:
45505       tags:
45506         - Network
45507       summary: update an existing l-interface
45508       description: |
45509         Update an existing l-interface
45510         #
45511         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45512         The PUT operation will entirely replace an existing object.
45513         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.
45514         #
45515         Other differences between PUT and PATCH are:
45516         #
45517         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45518         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45519         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45520       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
45521       consumes:
45522         - application/json
45523         - application/xml
45524       produces:
45525         - application/json
45526         - application/xml
45527       responses:
45528         "default":
45529           description: Response codes found in [response codes](https://wiki.onap.org/).
45530       parameters:
45531         - name: vnf-id2
45532           in: path
45533           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45534           required: true
45535           type: string
45536           example: __VNF-ID2__
45537         - name: interface-name
45538           in: path
45539           description: Name given to the interface
45540           required: true
45541           type: string
45542           example: __INTERFACE-NAME__
45543         - name: body
45544           in: body
45545           description: l-interface object that needs to be created or updated.
45546           required: true
45547           schema:
45548             $ref: "#/patchDefinitions/l-interface"
45549     delete:
45550       tags:
45551         - Network
45552       summary: delete an existing l-interface
45553       description: delete an existing l-interface
45554       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
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: vnf-id2
45566           in: path
45567           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45568           required: true
45569           type: string
45570           example: __VNF-ID2__
45571         - name: interface-name
45572           in: path
45573           description: Name given to the interface
45574           required: true
45575           type: string
45576           example: __INTERFACE-NAME__
45577         - name: resource-version
45578           in: query
45579           description: resource-version for concurrency
45580           required: true
45581           type: string
45582   /network/newvces/newvce/{vnf-id2}/l-interfaces:
45583     get:
45584       tags:
45585         - Network
45586       summary: returns l-interfaces
45587       description: returns l-interfaces
45588       operationId: getNetworkNewvcesNewvceLInterfaces
45589       produces:
45590         - application/json
45591         - application/xml
45592       responses:
45593         "200":
45594           description: successful operation
45595           schema:
45596               $ref: "#/getDefinitions/l-interfaces"
45597         "default":
45598           description: Response codes found in [response codes](https://wiki.onap.org/).
45599       parameters:
45600         - name: vnf-id2
45601           in: path
45602           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45603           required: true
45604           type: string
45605           example: __VNF-ID2__
45606         - name: vnf-name
45607           in: query
45608           description: Name of VNF.
45609           required: false
45610           type: string
45611         - name: vnf-name2
45612           in: query
45613           description: Alternate name of VNF.
45614           required: false
45615           type: string
45616         - name: vnf-type
45617           in: query
45618           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.
45619           required: false
45620           type: string
45621         - name: prov-status
45622           in: query
45623           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45624           required: false
45625           type: string
45626         - name: heat-stack-id
45627           in: query
45628           description: Heat stack id corresponding to this instance, managed by MSO
45629           required: false
45630           type: string
45631   /network/newvces/newvce/{vnf-id2}:
45632     get:
45633       tags:
45634         - Network
45635       summary: returns newvce
45636       description: returns newvce
45637       operationId: getNetworkNewvcesNewvce
45638       produces:
45639         - application/json
45640         - application/xml
45641       responses:
45642         "200":
45643           description: successful operation
45644           schema:
45645               $ref: "#/getDefinitions/newvce"
45646         "default":
45647           description: Response codes found in [response codes](https://wiki.onap.org/).
45648       parameters:
45649         - name: vnf-id2
45650           in: path
45651           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45652           required: true
45653           type: string
45654           example: __VNF-ID2__
45655         - name: vnf-name
45656           in: query
45657           description: Name of VNF.
45658           required: false
45659           type: string
45660         - name: vnf-name2
45661           in: query
45662           description: Alternate name of VNF.
45663           required: false
45664           type: string
45665         - name: vnf-type
45666           in: query
45667           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.
45668           required: false
45669           type: string
45670         - name: prov-status
45671           in: query
45672           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
45673           required: false
45674           type: string
45675         - name: heat-stack-id
45676           in: query
45677           description: Heat stack id corresponding to this instance, managed by MSO
45678           required: false
45679           type: string
45680     put:
45681       tags:
45682         - Network
45683       summary: create or update an existing newvce
45684       description: |
45685         Create or update an existing newvce.
45686         #
45687         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
45688       operationId: createOrUpdateNetworkNewvcesNewvce
45689       consumes:
45690         - application/json
45691         - application/xml
45692       produces:
45693         - application/json
45694         - application/xml
45695       responses:
45696         "default":
45697           description: Response codes found in [response codes](https://wiki.onap.org/).
45698       parameters:
45699         - name: vnf-id2
45700           in: path
45701           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45702           required: true
45703           type: string
45704           example: __VNF-ID2__
45705         - name: body
45706           in: body
45707           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
45708           required: true
45709           schema:
45710             $ref: "#/definitions/newvce"
45711     patch:
45712       tags:
45713         - Network
45714       summary: update an existing newvce
45715       description: |
45716         Update an existing newvce
45717         #
45718         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45719         The PUT operation will entirely replace an existing object.
45720         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.
45721         #
45722         Other differences between PUT and PATCH are:
45723         #
45724         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45725         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45726         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45727       operationId: UpdateNetworkNewvcesNewvce
45728       consumes:
45729         - application/json
45730         - application/xml
45731       produces:
45732         - application/json
45733         - application/xml
45734       responses:
45735         "default":
45736           description: Response codes found in [response codes](https://wiki.onap.org/).
45737       parameters:
45738         - name: vnf-id2
45739           in: path
45740           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45741           required: true
45742           type: string
45743           example: __VNF-ID2__
45744         - name: body
45745           in: body
45746           description: newvce object that needs to be created or updated.
45747           required: true
45748           schema:
45749             $ref: "#/patchDefinitions/newvce"
45750     delete:
45751       tags:
45752         - Network
45753       summary: delete an existing newvce
45754       description: delete an existing newvce
45755       operationId: deleteNetworkNewvcesNewvce
45756       consumes:
45757         - application/json
45758         - application/xml
45759       produces:
45760         - application/json
45761         - application/xml
45762       responses:
45763         "default":
45764           description: Response codes found in [response codes](https://wiki.onap.org/).
45765       parameters:
45766         - name: vnf-id2
45767           in: path
45768           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
45769           required: true
45770           type: string
45771           example: __VNF-ID2__
45772         - name: resource-version
45773           in: query
45774           description: resource-version for concurrency
45775           required: true
45776           type: string
45777   /network/newvces:
45778     get:
45779       tags:
45780         - Network
45781       summary: returns newvces
45782       description: returns newvces
45783       operationId: getNetworkNewvces
45784       produces:
45785         - application/json
45786         - application/xml
45787       responses:
45788         "200":
45789           description: successful operation
45790           schema:
45791               $ref: "#/getDefinitions/newvces"
45792         "default":
45793           description: Response codes found in [response codes](https://wiki.onap.org/).
45794   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
45795     put:
45796       tags:
45797         - Network
45798       summary: see node definition for valid relationships
45799       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
45800       consumes:
45801         - application/json
45802         - application/xml
45803       produces:
45804         - application/json
45805         - application/xml
45806       responses:
45807         "default":
45808           description: Response codes found in [response codes](https://wiki.onap.org/).
45809       parameters:
45810         - name: pnf-name
45811           in: path
45812           description: unique name of Physical Network Function.
45813           required: true
45814           type: string
45815           example: __PNF-NAME__
45816         - name: body
45817           in: body
45818           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
45819           required: true
45820           schema:
45821             $ref: "#/definitions/relationship"
45822     delete:
45823       tags:
45824         - Network
45825       summary: delete an existing relationship
45826       description: delete an existing relationship
45827       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
45828       consumes:
45829         - application/json
45830         - application/xml
45831       produces:
45832         - application/json
45833         - application/xml
45834       responses:
45835         "default":
45836           description: Response codes found in [response codes](https://wiki.onap.org/).
45837       parameters:
45838         - name: pnf-name
45839           in: path
45840           description: unique name of Physical Network Function.
45841           required: true
45842           type: string
45843           example: __PNF-NAME__
45844   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
45845     put:
45846       tags:
45847         - Network
45848       summary: see node definition for valid relationships
45849       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
45850       consumes:
45851         - application/json
45852         - application/xml
45853       produces:
45854         - application/json
45855         - application/xml
45856       responses:
45857         "default":
45858           description: Response codes found in [response codes](https://wiki.onap.org/).
45859       parameters:
45860         - name: pnf-name
45861           in: path
45862           description: unique name of Physical Network Function.
45863           required: true
45864           type: string
45865           example: __PNF-NAME__
45866         - name: interface-name
45867           in: path
45868           description: Name that identifies the physical interface
45869           required: true
45870           type: string
45871           example: __INTERFACE-NAME__
45872         - name: body
45873           in: body
45874           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
45875           required: true
45876           schema:
45877             $ref: "#/definitions/relationship"
45878     delete:
45879       tags:
45880         - Network
45881       summary: delete an existing relationship
45882       description: delete an existing relationship
45883       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
45884       consumes:
45885         - application/json
45886         - application/xml
45887       produces:
45888         - application/json
45889         - application/xml
45890       responses:
45891         "default":
45892           description: Response codes found in [response codes](https://wiki.onap.org/).
45893       parameters:
45894         - name: pnf-name
45895           in: path
45896           description: unique name of Physical Network Function.
45897           required: true
45898           type: string
45899           example: __PNF-NAME__
45900         - name: interface-name
45901           in: path
45902           description: Name that identifies the physical interface
45903           required: true
45904           type: string
45905           example: __INTERFACE-NAME__
45906   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
45907     put:
45908       tags:
45909         - Network
45910       summary: see node definition for valid relationships
45911       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45912       consumes:
45913         - application/json
45914         - application/xml
45915       produces:
45916         - application/json
45917         - application/xml
45918       responses:
45919         "default":
45920           description: Response codes found in [response codes](https://wiki.onap.org/).
45921       parameters:
45922         - name: pnf-name
45923           in: path
45924           description: unique name of Physical Network Function.
45925           required: true
45926           type: string
45927           example: __PNF-NAME__
45928         - name: interface-name
45929           in: path
45930           description: Name that identifies the physical interface
45931           required: true
45932           type: string
45933           example: __INTERFACE-NAME__
45934         - name: pf-pci-id
45935           in: path
45936           description: Identifier for the sriov-pf
45937           required: true
45938           type: string
45939           example: __PF-PCI-ID__
45940         - name: body
45941           in: body
45942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45943           required: true
45944           schema:
45945             $ref: "#/definitions/relationship"
45946     delete:
45947       tags:
45948         - Network
45949       summary: delete an existing relationship
45950       description: delete an existing relationship
45951       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45952       consumes:
45953         - application/json
45954         - application/xml
45955       produces:
45956         - application/json
45957         - application/xml
45958       responses:
45959         "default":
45960           description: Response codes found in [response codes](https://wiki.onap.org/).
45961       parameters:
45962         - name: pnf-name
45963           in: path
45964           description: unique name of Physical Network Function.
45965           required: true
45966           type: string
45967           example: __PNF-NAME__
45968         - name: interface-name
45969           in: path
45970           description: Name that identifies the physical interface
45971           required: true
45972           type: string
45973           example: __INTERFACE-NAME__
45974         - name: pf-pci-id
45975           in: path
45976           description: Identifier for the sriov-pf
45977           required: true
45978           type: string
45979           example: __PF-PCI-ID__
45980   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
45981     get:
45982       tags:
45983         - Network
45984       summary: returns sriov-pf
45985       description: returns sriov-pf
45986       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45987       produces:
45988         - application/json
45989         - application/xml
45990       responses:
45991         "200":
45992           description: successful operation
45993           schema:
45994               $ref: "#/getDefinitions/sriov-pf"
45995         "default":
45996           description: Response codes found in [response codes](https://wiki.onap.org/).
45997       parameters:
45998         - name: pnf-name
45999           in: path
46000           description: unique name of Physical Network Function.
46001           required: true
46002           type: string
46003           example: __PNF-NAME__
46004         - name: interface-name
46005           in: path
46006           description: Name that identifies the physical interface
46007           required: true
46008           type: string
46009           example: __INTERFACE-NAME__
46010         - name: pf-pci-id
46011           in: path
46012           description: Identifier for the sriov-pf
46013           required: true
46014           type: string
46015           example: __PF-PCI-ID__
46016         - name: inv-status
46017           in: query
46018           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46019           required: false
46020           type: string
46021         - name: prov-status
46022           in: query
46023           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46024           required: false
46025           type: string
46026     put:
46027       tags:
46028         - Network
46029       summary: create or update an existing sriov-pf
46030       description: |
46031         Create or update an existing sriov-pf.
46032         #
46033         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
46034       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46035       consumes:
46036         - application/json
46037         - application/xml
46038       produces:
46039         - application/json
46040         - application/xml
46041       responses:
46042         "default":
46043           description: Response codes found in [response codes](https://wiki.onap.org/).
46044       parameters:
46045         - name: pnf-name
46046           in: path
46047           description: unique name of Physical Network Function.
46048           required: true
46049           type: string
46050           example: __PNF-NAME__
46051         - name: interface-name
46052           in: path
46053           description: Name that identifies the physical interface
46054           required: true
46055           type: string
46056           example: __INTERFACE-NAME__
46057         - name: pf-pci-id
46058           in: path
46059           description: Identifier for the sriov-pf
46060           required: true
46061           type: string
46062           example: __PF-PCI-ID__
46063         - name: body
46064           in: body
46065           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
46066           required: true
46067           schema:
46068             $ref: "#/definitions/sriov-pf"
46069     patch:
46070       tags:
46071         - Network
46072       summary: update an existing sriov-pf
46073       description: |
46074         Update an existing sriov-pf
46075         #
46076         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46077         The PUT operation will entirely replace an existing object.
46078         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.
46079         #
46080         Other differences between PUT and PATCH are:
46081         #
46082         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46083         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46084         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46085       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46086       consumes:
46087         - application/json
46088         - application/xml
46089       produces:
46090         - application/json
46091         - application/xml
46092       responses:
46093         "default":
46094           description: Response codes found in [response codes](https://wiki.onap.org/).
46095       parameters:
46096         - name: pnf-name
46097           in: path
46098           description: unique name of Physical Network Function.
46099           required: true
46100           type: string
46101           example: __PNF-NAME__
46102         - name: interface-name
46103           in: path
46104           description: Name that identifies the physical interface
46105           required: true
46106           type: string
46107           example: __INTERFACE-NAME__
46108         - name: pf-pci-id
46109           in: path
46110           description: Identifier for the sriov-pf
46111           required: true
46112           type: string
46113           example: __PF-PCI-ID__
46114         - name: body
46115           in: body
46116           description: sriov-pf object that needs to be created or updated.
46117           required: true
46118           schema:
46119             $ref: "#/patchDefinitions/sriov-pf"
46120     delete:
46121       tags:
46122         - Network
46123       summary: delete an existing sriov-pf
46124       description: delete an existing sriov-pf
46125       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
46126       consumes:
46127         - application/json
46128         - application/xml
46129       produces:
46130         - application/json
46131         - application/xml
46132       responses:
46133         "default":
46134           description: Response codes found in [response codes](https://wiki.onap.org/).
46135       parameters:
46136         - name: pnf-name
46137           in: path
46138           description: unique name of Physical Network Function.
46139           required: true
46140           type: string
46141           example: __PNF-NAME__
46142         - name: interface-name
46143           in: path
46144           description: Name that identifies the physical interface
46145           required: true
46146           type: string
46147           example: __INTERFACE-NAME__
46148         - name: pf-pci-id
46149           in: path
46150           description: Identifier for the sriov-pf
46151           required: true
46152           type: string
46153           example: __PF-PCI-ID__
46154         - name: resource-version
46155           in: query
46156           description: resource-version for concurrency
46157           required: true
46158           type: string
46159   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
46160     get:
46161       tags:
46162         - Network
46163       summary: returns sriov-pfs
46164       description: returns sriov-pfs
46165       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
46166       produces:
46167         - application/json
46168         - application/xml
46169       responses:
46170         "200":
46171           description: successful operation
46172           schema:
46173               $ref: "#/getDefinitions/sriov-pfs"
46174         "default":
46175           description: Response codes found in [response codes](https://wiki.onap.org/).
46176       parameters:
46177         - name: pnf-name
46178           in: path
46179           description: unique name of Physical Network Function.
46180           required: true
46181           type: string
46182           example: __PNF-NAME__
46183         - name: interface-name
46184           in: path
46185           description: Name that identifies the physical interface
46186           required: true
46187           type: string
46188           example: __INTERFACE-NAME__
46189         - name: inv-status
46190           in: query
46191           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46192           required: false
46193           type: string
46194         - name: prov-status
46195           in: query
46196           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46197           required: false
46198           type: string
46199   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
46200     put:
46201       tags:
46202         - Network
46203       summary: see node definition for valid relationships
46204       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
46205       consumes:
46206         - application/json
46207         - application/xml
46208       produces:
46209         - application/json
46210         - application/xml
46211       responses:
46212         "default":
46213           description: Response codes found in [response codes](https://wiki.onap.org/).
46214       parameters:
46215         - name: pnf-name
46216           in: path
46217           description: unique name of Physical Network Function.
46218           required: true
46219           type: string
46220           example: __PNF-NAME__
46221         - name: interface-name
46222           in: path
46223           description: Name that identifies the physical interface
46224           required: true
46225           type: string
46226           example: __INTERFACE-NAME__
46227         - name: interface-name
46228           in: path
46229           description: Name given to the interface
46230           required: true
46231           type: string
46232           example: __INTERFACE-NAME__
46233         - name: vlan-interface
46234           in: path
46235           description: String that identifies the interface
46236           required: true
46237           type: string
46238           example: __VLAN-INTERFACE__
46239         - name: body
46240           in: body
46241           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
46242           required: true
46243           schema:
46244             $ref: "#/definitions/relationship"
46245     delete:
46246       tags:
46247         - Network
46248       summary: delete an existing relationship
46249       description: delete an existing relationship
46250       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
46251       consumes:
46252         - application/json
46253         - application/xml
46254       produces:
46255         - application/json
46256         - application/xml
46257       responses:
46258         "default":
46259           description: Response codes found in [response codes](https://wiki.onap.org/).
46260       parameters:
46261         - name: pnf-name
46262           in: path
46263           description: unique name of Physical Network Function.
46264           required: true
46265           type: string
46266           example: __PNF-NAME__
46267         - name: interface-name
46268           in: path
46269           description: Name that identifies the physical interface
46270           required: true
46271           type: string
46272           example: __INTERFACE-NAME__
46273         - name: interface-name
46274           in: path
46275           description: Name given to the interface
46276           required: true
46277           type: string
46278           example: __INTERFACE-NAME__
46279         - name: vlan-interface
46280           in: path
46281           description: String that identifies the interface
46282           required: true
46283           type: string
46284           example: __VLAN-INTERFACE__
46285   /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:
46286     put:
46287       tags:
46288         - Network
46289       summary: see node definition for valid relationships
46290       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
46291       consumes:
46292         - application/json
46293         - application/xml
46294       produces:
46295         - application/json
46296         - application/xml
46297       responses:
46298         "default":
46299           description: Response codes found in [response codes](https://wiki.onap.org/).
46300       parameters:
46301         - name: pnf-name
46302           in: path
46303           description: unique name of Physical Network Function.
46304           required: true
46305           type: string
46306           example: __PNF-NAME__
46307         - name: interface-name
46308           in: path
46309           description: Name that identifies the physical interface
46310           required: true
46311           type: string
46312           example: __INTERFACE-NAME__
46313         - name: interface-name
46314           in: path
46315           description: Name given to the interface
46316           required: true
46317           type: string
46318           example: __INTERFACE-NAME__
46319         - name: vlan-interface
46320           in: path
46321           description: String that identifies the interface
46322           required: true
46323           type: string
46324           example: __VLAN-INTERFACE__
46325         - name: l3-interface-ipv4-address
46326           in: path
46327           description: IP address
46328           required: true
46329           type: string
46330           example: __L3-INTERFACE-IPV4-ADDRESS__
46331         - name: body
46332           in: body
46333           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
46334           required: true
46335           schema:
46336             $ref: "#/definitions/relationship"
46337     delete:
46338       tags:
46339         - Network
46340       summary: delete an existing relationship
46341       description: delete an existing relationship
46342       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
46343       consumes:
46344         - application/json
46345         - application/xml
46346       produces:
46347         - application/json
46348         - application/xml
46349       responses:
46350         "default":
46351           description: Response codes found in [response codes](https://wiki.onap.org/).
46352       parameters:
46353         - name: pnf-name
46354           in: path
46355           description: unique name of Physical Network Function.
46356           required: true
46357           type: string
46358           example: __PNF-NAME__
46359         - name: interface-name
46360           in: path
46361           description: Name that identifies the physical interface
46362           required: true
46363           type: string
46364           example: __INTERFACE-NAME__
46365         - name: interface-name
46366           in: path
46367           description: Name given to the interface
46368           required: true
46369           type: string
46370           example: __INTERFACE-NAME__
46371         - name: vlan-interface
46372           in: path
46373           description: String that identifies the interface
46374           required: true
46375           type: string
46376           example: __VLAN-INTERFACE__
46377         - name: l3-interface-ipv4-address
46378           in: path
46379           description: IP address
46380           required: true
46381           type: string
46382           example: __L3-INTERFACE-IPV4-ADDRESS__
46383   /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}:
46384     get:
46385       tags:
46386         - Network
46387       summary: returns l3-interface-ipv4-address-list
46388       description: returns l3-interface-ipv4-address-list
46389       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46390       produces:
46391         - application/json
46392         - application/xml
46393       responses:
46394         "200":
46395           description: successful operation
46396           schema:
46397               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46398         "default":
46399           description: Response codes found in [response codes](https://wiki.onap.org/).
46400       parameters:
46401         - name: pnf-name
46402           in: path
46403           description: unique name of Physical Network Function.
46404           required: true
46405           type: string
46406           example: __PNF-NAME__
46407         - name: interface-name
46408           in: path
46409           description: Name that identifies the physical interface
46410           required: true
46411           type: string
46412           example: __INTERFACE-NAME__
46413         - name: interface-name
46414           in: path
46415           description: Name given to the interface
46416           required: true
46417           type: string
46418           example: __INTERFACE-NAME__
46419         - name: vlan-interface
46420           in: path
46421           description: String that identifies the interface
46422           required: true
46423           type: string
46424           example: __VLAN-INTERFACE__
46425         - name: l3-interface-ipv4-address
46426           in: path
46427           description: IP address
46428           required: true
46429           type: string
46430           example: __L3-INTERFACE-IPV4-ADDRESS__
46431         - name: inv-status
46432           in: query
46433           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46434           required: false
46435           type: string
46436         - name: prov-status
46437           in: query
46438           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46439           required: false
46440           type: string
46441         - name: interface-id
46442           in: query
46443           description: ID of interface
46444           required: false
46445           type: string
46446         - name: macaddr
46447           in: query
46448           description: MAC address for the interface
46449           required: false
46450           type: string
46451         - name: network-name
46452           in: query
46453           description: Name of the network
46454           required: false
46455           type: string
46456         - name: vlan-id-inner
46457           in: query
46458           description: Inner VLAN tag
46459           required: false
46460           type: integer
46461           format: int64
46462         - name: vpn-key
46463           in: query
46464           description: This indicates the customers VPN ID associated with this vlan
46465           required: false
46466           type: string
46467         - name: vlan-id-inner
46468           in: query
46469           description: Inner VLAN tag
46470           required: false
46471           type: integer
46472           format: int64
46473         - name: neutron-network-id
46474           in: query
46475           description: Neutron network id of the interface that address belongs to
46476           required: false
46477           type: string
46478         - name: neutron-subnet-id
46479           in: query
46480           description: Neutron id of subnet that address belongs to
46481           required: false
46482           type: string
46483     put:
46484       tags:
46485         - Network
46486       summary: create or update an existing l3-interface-ipv4-address-list
46487       description: |
46488         Create or update an existing l3-interface-ipv4-address-list.
46489         #
46490         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
46491       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46492       consumes:
46493         - application/json
46494         - application/xml
46495       produces:
46496         - application/json
46497         - application/xml
46498       responses:
46499         "default":
46500           description: Response codes found in [response codes](https://wiki.onap.org/).
46501       parameters:
46502         - name: pnf-name
46503           in: path
46504           description: unique name of Physical Network Function.
46505           required: true
46506           type: string
46507           example: __PNF-NAME__
46508         - name: interface-name
46509           in: path
46510           description: Name that identifies the physical interface
46511           required: true
46512           type: string
46513           example: __INTERFACE-NAME__
46514         - name: interface-name
46515           in: path
46516           description: Name given to the interface
46517           required: true
46518           type: string
46519           example: __INTERFACE-NAME__
46520         - name: vlan-interface
46521           in: path
46522           description: String that identifies the interface
46523           required: true
46524           type: string
46525           example: __VLAN-INTERFACE__
46526         - name: l3-interface-ipv4-address
46527           in: path
46528           description: IP address
46529           required: true
46530           type: string
46531           example: __L3-INTERFACE-IPV4-ADDRESS__
46532         - name: body
46533           in: body
46534           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
46535           required: true
46536           schema:
46537             $ref: "#/definitions/l3-interface-ipv4-address-list"
46538     patch:
46539       tags:
46540         - Network
46541       summary: update an existing l3-interface-ipv4-address-list
46542       description: |
46543         Update an existing l3-interface-ipv4-address-list
46544         #
46545         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46546         The PUT operation will entirely replace an existing object.
46547         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.
46548         #
46549         Other differences between PUT and PATCH are:
46550         #
46551         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46552         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46553         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46554       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46555       consumes:
46556         - application/json
46557         - application/xml
46558       produces:
46559         - application/json
46560         - application/xml
46561       responses:
46562         "default":
46563           description: Response codes found in [response codes](https://wiki.onap.org/).
46564       parameters:
46565         - name: pnf-name
46566           in: path
46567           description: unique name of Physical Network Function.
46568           required: true
46569           type: string
46570           example: __PNF-NAME__
46571         - name: interface-name
46572           in: path
46573           description: Name that identifies the physical interface
46574           required: true
46575           type: string
46576           example: __INTERFACE-NAME__
46577         - name: interface-name
46578           in: path
46579           description: Name given to the interface
46580           required: true
46581           type: string
46582           example: __INTERFACE-NAME__
46583         - name: vlan-interface
46584           in: path
46585           description: String that identifies the interface
46586           required: true
46587           type: string
46588           example: __VLAN-INTERFACE__
46589         - name: l3-interface-ipv4-address
46590           in: path
46591           description: IP address
46592           required: true
46593           type: string
46594           example: __L3-INTERFACE-IPV4-ADDRESS__
46595         - name: body
46596           in: body
46597           description: l3-interface-ipv4-address-list object that needs to be created or updated.
46598           required: true
46599           schema:
46600             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
46601     delete:
46602       tags:
46603         - Network
46604       summary: delete an existing l3-interface-ipv4-address-list
46605       description: delete an existing l3-interface-ipv4-address-list
46606       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
46607       consumes:
46608         - application/json
46609         - application/xml
46610       produces:
46611         - application/json
46612         - application/xml
46613       responses:
46614         "default":
46615           description: Response codes found in [response codes](https://wiki.onap.org/).
46616       parameters:
46617         - name: pnf-name
46618           in: path
46619           description: unique name of Physical Network Function.
46620           required: true
46621           type: string
46622           example: __PNF-NAME__
46623         - name: interface-name
46624           in: path
46625           description: Name that identifies the physical interface
46626           required: true
46627           type: string
46628           example: __INTERFACE-NAME__
46629         - name: interface-name
46630           in: path
46631           description: Name given to the interface
46632           required: true
46633           type: string
46634           example: __INTERFACE-NAME__
46635         - name: vlan-interface
46636           in: path
46637           description: String that identifies the interface
46638           required: true
46639           type: string
46640           example: __VLAN-INTERFACE__
46641         - name: l3-interface-ipv4-address
46642           in: path
46643           description: IP address
46644           required: true
46645           type: string
46646           example: __L3-INTERFACE-IPV4-ADDRESS__
46647         - name: resource-version
46648           in: query
46649           description: resource-version for concurrency
46650           required: true
46651           type: string
46652   /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:
46653     put:
46654       tags:
46655         - Network
46656       summary: see node definition for valid relationships
46657       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
46658       consumes:
46659         - application/json
46660         - application/xml
46661       produces:
46662         - application/json
46663         - application/xml
46664       responses:
46665         "default":
46666           description: Response codes found in [response codes](https://wiki.onap.org/).
46667       parameters:
46668         - name: pnf-name
46669           in: path
46670           description: unique name of Physical Network Function.
46671           required: true
46672           type: string
46673           example: __PNF-NAME__
46674         - name: interface-name
46675           in: path
46676           description: Name that identifies the physical interface
46677           required: true
46678           type: string
46679           example: __INTERFACE-NAME__
46680         - name: interface-name
46681           in: path
46682           description: Name given to the interface
46683           required: true
46684           type: string
46685           example: __INTERFACE-NAME__
46686         - name: vlan-interface
46687           in: path
46688           description: String that identifies the interface
46689           required: true
46690           type: string
46691           example: __VLAN-INTERFACE__
46692         - name: l3-interface-ipv6-address
46693           in: path
46694           description: IP address
46695           required: true
46696           type: string
46697           example: __L3-INTERFACE-IPV6-ADDRESS__
46698         - name: body
46699           in: body
46700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
46701           required: true
46702           schema:
46703             $ref: "#/definitions/relationship"
46704     delete:
46705       tags:
46706         - Network
46707       summary: delete an existing relationship
46708       description: delete an existing relationship
46709       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
46710       consumes:
46711         - application/json
46712         - application/xml
46713       produces:
46714         - application/json
46715         - application/xml
46716       responses:
46717         "default":
46718           description: Response codes found in [response codes](https://wiki.onap.org/).
46719       parameters:
46720         - name: pnf-name
46721           in: path
46722           description: unique name of Physical Network Function.
46723           required: true
46724           type: string
46725           example: __PNF-NAME__
46726         - name: interface-name
46727           in: path
46728           description: Name that identifies the physical interface
46729           required: true
46730           type: string
46731           example: __INTERFACE-NAME__
46732         - name: interface-name
46733           in: path
46734           description: Name given to the interface
46735           required: true
46736           type: string
46737           example: __INTERFACE-NAME__
46738         - name: vlan-interface
46739           in: path
46740           description: String that identifies the interface
46741           required: true
46742           type: string
46743           example: __VLAN-INTERFACE__
46744         - name: l3-interface-ipv6-address
46745           in: path
46746           description: IP address
46747           required: true
46748           type: string
46749           example: __L3-INTERFACE-IPV6-ADDRESS__
46750   /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}:
46751     get:
46752       tags:
46753         - Network
46754       summary: returns l3-interface-ipv6-address-list
46755       description: returns l3-interface-ipv6-address-list
46756       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46757       produces:
46758         - application/json
46759         - application/xml
46760       responses:
46761         "200":
46762           description: successful operation
46763           schema:
46764               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
46765         "default":
46766           description: Response codes found in [response codes](https://wiki.onap.org/).
46767       parameters:
46768         - name: pnf-name
46769           in: path
46770           description: unique name of Physical Network Function.
46771           required: true
46772           type: string
46773           example: __PNF-NAME__
46774         - name: interface-name
46775           in: path
46776           description: Name that identifies the physical interface
46777           required: true
46778           type: string
46779           example: __INTERFACE-NAME__
46780         - name: interface-name
46781           in: path
46782           description: Name given to the interface
46783           required: true
46784           type: string
46785           example: __INTERFACE-NAME__
46786         - name: vlan-interface
46787           in: path
46788           description: String that identifies the interface
46789           required: true
46790           type: string
46791           example: __VLAN-INTERFACE__
46792         - name: l3-interface-ipv6-address
46793           in: path
46794           description: IP address
46795           required: true
46796           type: string
46797           example: __L3-INTERFACE-IPV6-ADDRESS__
46798         - name: inv-status
46799           in: query
46800           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46801           required: false
46802           type: string
46803         - name: prov-status
46804           in: query
46805           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46806           required: false
46807           type: string
46808         - name: interface-id
46809           in: query
46810           description: ID of interface
46811           required: false
46812           type: string
46813         - name: macaddr
46814           in: query
46815           description: MAC address for the interface
46816           required: false
46817           type: string
46818         - name: network-name
46819           in: query
46820           description: Name of the network
46821           required: false
46822           type: string
46823         - name: vlan-id-inner
46824           in: query
46825           description: Inner VLAN tag
46826           required: false
46827           type: integer
46828           format: int64
46829         - name: vpn-key
46830           in: query
46831           description: This indicates the customers VPN ID associated with this vlan
46832           required: false
46833           type: string
46834         - name: vlan-id-inner
46835           in: query
46836           description: Inner VLAN tag
46837           required: false
46838           type: integer
46839           format: int64
46840         - name: neutron-network-id
46841           in: query
46842           description: Neutron network id of the interface that address belongs to
46843           required: false
46844           type: string
46845         - name: neutron-subnet-id
46846           in: query
46847           description: Neutron id of subnet that address belongs to
46848           required: false
46849           type: string
46850     put:
46851       tags:
46852         - Network
46853       summary: create or update an existing l3-interface-ipv6-address-list
46854       description: |
46855         Create or update an existing l3-interface-ipv6-address-list.
46856         #
46857         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
46858       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46859       consumes:
46860         - application/json
46861         - application/xml
46862       produces:
46863         - application/json
46864         - application/xml
46865       responses:
46866         "default":
46867           description: Response codes found in [response codes](https://wiki.onap.org/).
46868       parameters:
46869         - name: pnf-name
46870           in: path
46871           description: unique name of Physical Network Function.
46872           required: true
46873           type: string
46874           example: __PNF-NAME__
46875         - name: interface-name
46876           in: path
46877           description: Name that identifies the physical interface
46878           required: true
46879           type: string
46880           example: __INTERFACE-NAME__
46881         - name: interface-name
46882           in: path
46883           description: Name given to the interface
46884           required: true
46885           type: string
46886           example: __INTERFACE-NAME__
46887         - name: vlan-interface
46888           in: path
46889           description: String that identifies the interface
46890           required: true
46891           type: string
46892           example: __VLAN-INTERFACE__
46893         - name: l3-interface-ipv6-address
46894           in: path
46895           description: IP address
46896           required: true
46897           type: string
46898           example: __L3-INTERFACE-IPV6-ADDRESS__
46899         - name: body
46900           in: body
46901           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
46902           required: true
46903           schema:
46904             $ref: "#/definitions/l3-interface-ipv6-address-list"
46905     patch:
46906       tags:
46907         - Network
46908       summary: update an existing l3-interface-ipv6-address-list
46909       description: |
46910         Update an existing l3-interface-ipv6-address-list
46911         #
46912         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46913         The PUT operation will entirely replace an existing object.
46914         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.
46915         #
46916         Other differences between PUT and PATCH are:
46917         #
46918         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46919         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46920         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46921       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46922       consumes:
46923         - application/json
46924         - application/xml
46925       produces:
46926         - application/json
46927         - application/xml
46928       responses:
46929         "default":
46930           description: Response codes found in [response codes](https://wiki.onap.org/).
46931       parameters:
46932         - name: pnf-name
46933           in: path
46934           description: unique name of Physical Network Function.
46935           required: true
46936           type: string
46937           example: __PNF-NAME__
46938         - name: interface-name
46939           in: path
46940           description: Name that identifies the physical interface
46941           required: true
46942           type: string
46943           example: __INTERFACE-NAME__
46944         - name: interface-name
46945           in: path
46946           description: Name given to the interface
46947           required: true
46948           type: string
46949           example: __INTERFACE-NAME__
46950         - name: vlan-interface
46951           in: path
46952           description: String that identifies the interface
46953           required: true
46954           type: string
46955           example: __VLAN-INTERFACE__
46956         - name: l3-interface-ipv6-address
46957           in: path
46958           description: IP address
46959           required: true
46960           type: string
46961           example: __L3-INTERFACE-IPV6-ADDRESS__
46962         - name: body
46963           in: body
46964           description: l3-interface-ipv6-address-list object that needs to be created or updated.
46965           required: true
46966           schema:
46967             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
46968     delete:
46969       tags:
46970         - Network
46971       summary: delete an existing l3-interface-ipv6-address-list
46972       description: delete an existing l3-interface-ipv6-address-list
46973       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46974       consumes:
46975         - application/json
46976         - application/xml
46977       produces:
46978         - application/json
46979         - application/xml
46980       responses:
46981         "default":
46982           description: Response codes found in [response codes](https://wiki.onap.org/).
46983       parameters:
46984         - name: pnf-name
46985           in: path
46986           description: unique name of Physical Network Function.
46987           required: true
46988           type: string
46989           example: __PNF-NAME__
46990         - name: interface-name
46991           in: path
46992           description: Name that identifies the physical interface
46993           required: true
46994           type: string
46995           example: __INTERFACE-NAME__
46996         - name: interface-name
46997           in: path
46998           description: Name given to the interface
46999           required: true
47000           type: string
47001           example: __INTERFACE-NAME__
47002         - name: vlan-interface
47003           in: path
47004           description: String that identifies the interface
47005           required: true
47006           type: string
47007           example: __VLAN-INTERFACE__
47008         - name: l3-interface-ipv6-address
47009           in: path
47010           description: IP address
47011           required: true
47012           type: string
47013           example: __L3-INTERFACE-IPV6-ADDRESS__
47014         - name: resource-version
47015           in: query
47016           description: resource-version for concurrency
47017           required: true
47018           type: string
47019   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
47020     get:
47021       tags:
47022         - Network
47023       summary: returns vlan
47024       description: returns vlan
47025       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47026       produces:
47027         - application/json
47028         - application/xml
47029       responses:
47030         "200":
47031           description: successful operation
47032           schema:
47033               $ref: "#/getDefinitions/vlan"
47034         "default":
47035           description: Response codes found in [response codes](https://wiki.onap.org/).
47036       parameters:
47037         - name: pnf-name
47038           in: path
47039           description: unique name of Physical Network Function.
47040           required: true
47041           type: string
47042           example: __PNF-NAME__
47043         - name: interface-name
47044           in: path
47045           description: Name that identifies the physical interface
47046           required: true
47047           type: string
47048           example: __INTERFACE-NAME__
47049         - name: interface-name
47050           in: path
47051           description: Name given to the interface
47052           required: true
47053           type: string
47054           example: __INTERFACE-NAME__
47055         - name: vlan-interface
47056           in: path
47057           description: String that identifies the interface
47058           required: true
47059           type: string
47060           example: __VLAN-INTERFACE__
47061         - name: inv-status
47062           in: query
47063           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47064           required: false
47065           type: string
47066         - name: prov-status
47067           in: query
47068           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47069           required: false
47070           type: string
47071         - name: interface-id
47072           in: query
47073           description: ID of interface
47074           required: false
47075           type: string
47076         - name: macaddr
47077           in: query
47078           description: MAC address for the interface
47079           required: false
47080           type: string
47081         - name: network-name
47082           in: query
47083           description: Name of the network
47084           required: false
47085           type: string
47086         - name: vlan-id-inner
47087           in: query
47088           description: Inner VLAN tag
47089           required: false
47090           type: integer
47091           format: int64
47092         - name: vpn-key
47093           in: query
47094           description: This indicates the customers VPN ID associated with this vlan
47095           required: false
47096           type: string
47097     put:
47098       tags:
47099         - Network
47100       summary: create or update an existing vlan
47101       description: |
47102         Create or update an existing vlan.
47103         #
47104         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
47105       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47106       consumes:
47107         - application/json
47108         - application/xml
47109       produces:
47110         - application/json
47111         - application/xml
47112       responses:
47113         "default":
47114           description: Response codes found in [response codes](https://wiki.onap.org/).
47115       parameters:
47116         - name: pnf-name
47117           in: path
47118           description: unique name of Physical Network Function.
47119           required: true
47120           type: string
47121           example: __PNF-NAME__
47122         - name: interface-name
47123           in: path
47124           description: Name that identifies the physical interface
47125           required: true
47126           type: string
47127           example: __INTERFACE-NAME__
47128         - name: interface-name
47129           in: path
47130           description: Name given to the interface
47131           required: true
47132           type: string
47133           example: __INTERFACE-NAME__
47134         - name: vlan-interface
47135           in: path
47136           description: String that identifies the interface
47137           required: true
47138           type: string
47139           example: __VLAN-INTERFACE__
47140         - name: body
47141           in: body
47142           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
47143           required: true
47144           schema:
47145             $ref: "#/definitions/vlan"
47146     patch:
47147       tags:
47148         - Network
47149       summary: update an existing vlan
47150       description: |
47151         Update an existing vlan
47152         #
47153         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47154         The PUT operation will entirely replace an existing object.
47155         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.
47156         #
47157         Other differences between PUT and PATCH are:
47158         #
47159         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47160         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47161         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47162       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47163       consumes:
47164         - application/json
47165         - application/xml
47166       produces:
47167         - application/json
47168         - application/xml
47169       responses:
47170         "default":
47171           description: Response codes found in [response codes](https://wiki.onap.org/).
47172       parameters:
47173         - name: pnf-name
47174           in: path
47175           description: unique name of Physical Network Function.
47176           required: true
47177           type: string
47178           example: __PNF-NAME__
47179         - name: interface-name
47180           in: path
47181           description: Name that identifies the physical interface
47182           required: true
47183           type: string
47184           example: __INTERFACE-NAME__
47185         - name: interface-name
47186           in: path
47187           description: Name given to the interface
47188           required: true
47189           type: string
47190           example: __INTERFACE-NAME__
47191         - name: vlan-interface
47192           in: path
47193           description: String that identifies the interface
47194           required: true
47195           type: string
47196           example: __VLAN-INTERFACE__
47197         - name: body
47198           in: body
47199           description: vlan object that needs to be created or updated.
47200           required: true
47201           schema:
47202             $ref: "#/patchDefinitions/vlan"
47203     delete:
47204       tags:
47205         - Network
47206       summary: delete an existing vlan
47207       description: delete an existing vlan
47208       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
47209       consumes:
47210         - application/json
47211         - application/xml
47212       produces:
47213         - application/json
47214         - application/xml
47215       responses:
47216         "default":
47217           description: Response codes found in [response codes](https://wiki.onap.org/).
47218       parameters:
47219         - name: pnf-name
47220           in: path
47221           description: unique name of Physical Network Function.
47222           required: true
47223           type: string
47224           example: __PNF-NAME__
47225         - name: interface-name
47226           in: path
47227           description: Name that identifies the physical interface
47228           required: true
47229           type: string
47230           example: __INTERFACE-NAME__
47231         - name: interface-name
47232           in: path
47233           description: Name given to the interface
47234           required: true
47235           type: string
47236           example: __INTERFACE-NAME__
47237         - name: vlan-interface
47238           in: path
47239           description: String that identifies the interface
47240           required: true
47241           type: string
47242           example: __VLAN-INTERFACE__
47243         - name: resource-version
47244           in: query
47245           description: resource-version for concurrency
47246           required: true
47247           type: string
47248   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
47249     get:
47250       tags:
47251         - Network
47252       summary: returns vlans
47253       description: returns vlans
47254       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
47255       produces:
47256         - application/json
47257         - application/xml
47258       responses:
47259         "200":
47260           description: successful operation
47261           schema:
47262               $ref: "#/getDefinitions/vlans"
47263         "default":
47264           description: Response codes found in [response codes](https://wiki.onap.org/).
47265       parameters:
47266         - name: pnf-name
47267           in: path
47268           description: unique name of Physical Network Function.
47269           required: true
47270           type: string
47271           example: __PNF-NAME__
47272         - name: interface-name
47273           in: path
47274           description: Name that identifies the physical interface
47275           required: true
47276           type: string
47277           example: __INTERFACE-NAME__
47278         - name: interface-name
47279           in: path
47280           description: Name given to the interface
47281           required: true
47282           type: string
47283           example: __INTERFACE-NAME__
47284         - name: inv-status
47285           in: query
47286           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47287           required: false
47288           type: string
47289         - name: prov-status
47290           in: query
47291           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47292           required: false
47293           type: string
47294         - name: interface-id
47295           in: query
47296           description: ID of interface
47297           required: false
47298           type: string
47299         - name: macaddr
47300           in: query
47301           description: MAC address for the interface
47302           required: false
47303           type: string
47304         - name: network-name
47305           in: query
47306           description: Name of the network
47307           required: false
47308           type: string
47309   /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:
47310     put:
47311       tags:
47312         - Network
47313       summary: see node definition for valid relationships
47314       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
47315       consumes:
47316         - application/json
47317         - application/xml
47318       produces:
47319         - application/json
47320         - application/xml
47321       responses:
47322         "default":
47323           description: Response codes found in [response codes](https://wiki.onap.org/).
47324       parameters:
47325         - name: pnf-name
47326           in: path
47327           description: unique name of Physical Network Function.
47328           required: true
47329           type: string
47330           example: __PNF-NAME__
47331         - name: interface-name
47332           in: path
47333           description: Name that identifies the physical interface
47334           required: true
47335           type: string
47336           example: __INTERFACE-NAME__
47337         - name: interface-name
47338           in: path
47339           description: Name given to the interface
47340           required: true
47341           type: string
47342           example: __INTERFACE-NAME__
47343         - name: pci-id
47344           in: path
47345           description: PCI ID used to identify the sriov-vf
47346           required: true
47347           type: string
47348           example: __PCI-ID__
47349         - name: body
47350           in: body
47351           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
47352           required: true
47353           schema:
47354             $ref: "#/definitions/relationship"
47355     delete:
47356       tags:
47357         - Network
47358       summary: delete an existing relationship
47359       description: delete an existing relationship
47360       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
47361       consumes:
47362         - application/json
47363         - application/xml
47364       produces:
47365         - application/json
47366         - application/xml
47367       responses:
47368         "default":
47369           description: Response codes found in [response codes](https://wiki.onap.org/).
47370       parameters:
47371         - name: pnf-name
47372           in: path
47373           description: unique name of Physical Network Function.
47374           required: true
47375           type: string
47376           example: __PNF-NAME__
47377         - name: interface-name
47378           in: path
47379           description: Name that identifies the physical interface
47380           required: true
47381           type: string
47382           example: __INTERFACE-NAME__
47383         - name: interface-name
47384           in: path
47385           description: Name given to the interface
47386           required: true
47387           type: string
47388           example: __INTERFACE-NAME__
47389         - name: pci-id
47390           in: path
47391           description: PCI ID used to identify the sriov-vf
47392           required: true
47393           type: string
47394           example: __PCI-ID__
47395   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
47396     get:
47397       tags:
47398         - Network
47399       summary: returns sriov-vf
47400       description: returns sriov-vf
47401       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47402       produces:
47403         - application/json
47404         - application/xml
47405       responses:
47406         "200":
47407           description: successful operation
47408           schema:
47409               $ref: "#/getDefinitions/sriov-vf"
47410         "default":
47411           description: Response codes found in [response codes](https://wiki.onap.org/).
47412       parameters:
47413         - name: pnf-name
47414           in: path
47415           description: unique name of Physical Network Function.
47416           required: true
47417           type: string
47418           example: __PNF-NAME__
47419         - name: interface-name
47420           in: path
47421           description: Name that identifies the physical interface
47422           required: true
47423           type: string
47424           example: __INTERFACE-NAME__
47425         - name: interface-name
47426           in: path
47427           description: Name given to the interface
47428           required: true
47429           type: string
47430           example: __INTERFACE-NAME__
47431         - name: pci-id
47432           in: path
47433           description: PCI ID used to identify the sriov-vf
47434           required: true
47435           type: string
47436           example: __PCI-ID__
47437         - name: inv-status
47438           in: query
47439           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47440           required: false
47441           type: string
47442         - name: prov-status
47443           in: query
47444           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47445           required: false
47446           type: string
47447         - name: interface-id
47448           in: query
47449           description: ID of interface
47450           required: false
47451           type: string
47452         - name: macaddr
47453           in: query
47454           description: MAC address for the interface
47455           required: false
47456           type: string
47457         - name: network-name
47458           in: query
47459           description: Name of the network
47460           required: false
47461           type: string
47462         - name: vf-vlan-filter
47463           in: query
47464           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
47465           required: false
47466           type: string
47467         - name: vf-mac-filter
47468           in: query
47469           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
47470           required: false
47471           type: string
47472         - name: vf-vlan-strip
47473           in: query
47474           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
47475           required: false
47476           type: boolean
47477         - name: neutron-network-id
47478           in: query
47479           description: Neutron network id of the interface
47480           required: false
47481           type: string
47482     put:
47483       tags:
47484         - Network
47485       summary: create or update an existing sriov-vf
47486       description: |
47487         Create or update an existing sriov-vf.
47488         #
47489         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
47490       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47491       consumes:
47492         - application/json
47493         - application/xml
47494       produces:
47495         - application/json
47496         - application/xml
47497       responses:
47498         "default":
47499           description: Response codes found in [response codes](https://wiki.onap.org/).
47500       parameters:
47501         - name: pnf-name
47502           in: path
47503           description: unique name of Physical Network Function.
47504           required: true
47505           type: string
47506           example: __PNF-NAME__
47507         - name: interface-name
47508           in: path
47509           description: Name that identifies the physical interface
47510           required: true
47511           type: string
47512           example: __INTERFACE-NAME__
47513         - name: interface-name
47514           in: path
47515           description: Name given to the interface
47516           required: true
47517           type: string
47518           example: __INTERFACE-NAME__
47519         - name: pci-id
47520           in: path
47521           description: PCI ID used to identify the sriov-vf
47522           required: true
47523           type: string
47524           example: __PCI-ID__
47525         - name: body
47526           in: body
47527           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
47528           required: true
47529           schema:
47530             $ref: "#/definitions/sriov-vf"
47531     patch:
47532       tags:
47533         - Network
47534       summary: update an existing sriov-vf
47535       description: |
47536         Update an existing sriov-vf
47537         #
47538         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47539         The PUT operation will entirely replace an existing object.
47540         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.
47541         #
47542         Other differences between PUT and PATCH are:
47543         #
47544         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47545         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47546         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47547       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47548       consumes:
47549         - application/json
47550         - application/xml
47551       produces:
47552         - application/json
47553         - application/xml
47554       responses:
47555         "default":
47556           description: Response codes found in [response codes](https://wiki.onap.org/).
47557       parameters:
47558         - name: pnf-name
47559           in: path
47560           description: unique name of Physical Network Function.
47561           required: true
47562           type: string
47563           example: __PNF-NAME__
47564         - name: interface-name
47565           in: path
47566           description: Name that identifies the physical interface
47567           required: true
47568           type: string
47569           example: __INTERFACE-NAME__
47570         - name: interface-name
47571           in: path
47572           description: Name given to the interface
47573           required: true
47574           type: string
47575           example: __INTERFACE-NAME__
47576         - name: pci-id
47577           in: path
47578           description: PCI ID used to identify the sriov-vf
47579           required: true
47580           type: string
47581           example: __PCI-ID__
47582         - name: body
47583           in: body
47584           description: sriov-vf object that needs to be created or updated.
47585           required: true
47586           schema:
47587             $ref: "#/patchDefinitions/sriov-vf"
47588     delete:
47589       tags:
47590         - Network
47591       summary: delete an existing sriov-vf
47592       description: delete an existing sriov-vf
47593       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
47594       consumes:
47595         - application/json
47596         - application/xml
47597       produces:
47598         - application/json
47599         - application/xml
47600       responses:
47601         "default":
47602           description: Response codes found in [response codes](https://wiki.onap.org/).
47603       parameters:
47604         - name: pnf-name
47605           in: path
47606           description: unique name of Physical Network Function.
47607           required: true
47608           type: string
47609           example: __PNF-NAME__
47610         - name: interface-name
47611           in: path
47612           description: Name that identifies the physical interface
47613           required: true
47614           type: string
47615           example: __INTERFACE-NAME__
47616         - name: interface-name
47617           in: path
47618           description: Name given to the interface
47619           required: true
47620           type: string
47621           example: __INTERFACE-NAME__
47622         - name: pci-id
47623           in: path
47624           description: PCI ID used to identify the sriov-vf
47625           required: true
47626           type: string
47627           example: __PCI-ID__
47628         - name: resource-version
47629           in: query
47630           description: resource-version for concurrency
47631           required: true
47632           type: string
47633   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
47634     get:
47635       tags:
47636         - Network
47637       summary: returns sriov-vfs
47638       description: returns sriov-vfs
47639       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
47640       produces:
47641         - application/json
47642         - application/xml
47643       responses:
47644         "200":
47645           description: successful operation
47646           schema:
47647               $ref: "#/getDefinitions/sriov-vfs"
47648         "default":
47649           description: Response codes found in [response codes](https://wiki.onap.org/).
47650       parameters:
47651         - name: pnf-name
47652           in: path
47653           description: unique name of Physical Network Function.
47654           required: true
47655           type: string
47656           example: __PNF-NAME__
47657         - name: interface-name
47658           in: path
47659           description: Name that identifies the physical interface
47660           required: true
47661           type: string
47662           example: __INTERFACE-NAME__
47663         - name: interface-name
47664           in: path
47665           description: Name given to the interface
47666           required: true
47667           type: string
47668           example: __INTERFACE-NAME__
47669         - name: inv-status
47670           in: query
47671           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47672           required: false
47673           type: string
47674         - name: prov-status
47675           in: query
47676           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47677           required: false
47678           type: string
47679         - name: interface-id
47680           in: query
47681           description: ID of interface
47682           required: false
47683           type: string
47684         - name: macaddr
47685           in: query
47686           description: MAC address for the interface
47687           required: false
47688           type: string
47689         - name: network-name
47690           in: query
47691           description: Name of the network
47692           required: false
47693           type: string
47694   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
47695     put:
47696       tags:
47697         - Network
47698       summary: see node definition for valid relationships
47699       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
47700       consumes:
47701         - application/json
47702         - application/xml
47703       produces:
47704         - application/json
47705         - application/xml
47706       responses:
47707         "default":
47708           description: Response codes found in [response codes](https://wiki.onap.org/).
47709       parameters:
47710         - name: pnf-name
47711           in: path
47712           description: unique name of Physical Network Function.
47713           required: true
47714           type: string
47715           example: __PNF-NAME__
47716         - name: interface-name
47717           in: path
47718           description: Name that identifies the physical interface
47719           required: true
47720           type: string
47721           example: __INTERFACE-NAME__
47722         - name: interface-name
47723           in: path
47724           description: Name given to the interface
47725           required: true
47726           type: string
47727           example: __INTERFACE-NAME__
47728         - name: body
47729           in: body
47730           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
47731           required: true
47732           schema:
47733             $ref: "#/definitions/relationship"
47734     delete:
47735       tags:
47736         - Network
47737       summary: delete an existing relationship
47738       description: delete an existing relationship
47739       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
47740       consumes:
47741         - application/json
47742         - application/xml
47743       produces:
47744         - application/json
47745         - application/xml
47746       responses:
47747         "default":
47748           description: Response codes found in [response codes](https://wiki.onap.org/).
47749       parameters:
47750         - name: pnf-name
47751           in: path
47752           description: unique name of Physical Network Function.
47753           required: true
47754           type: string
47755           example: __PNF-NAME__
47756         - name: interface-name
47757           in: path
47758           description: Name that identifies the physical interface
47759           required: true
47760           type: string
47761           example: __INTERFACE-NAME__
47762         - name: interface-name
47763           in: path
47764           description: Name given to the interface
47765           required: true
47766           type: string
47767           example: __INTERFACE-NAME__
47768   /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:
47769     put:
47770       tags:
47771         - Network
47772       summary: see node definition for valid relationships
47773       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
47774       consumes:
47775         - application/json
47776         - application/xml
47777       produces:
47778         - application/json
47779         - application/xml
47780       responses:
47781         "default":
47782           description: Response codes found in [response codes](https://wiki.onap.org/).
47783       parameters:
47784         - name: pnf-name
47785           in: path
47786           description: unique name of Physical Network Function.
47787           required: true
47788           type: string
47789           example: __PNF-NAME__
47790         - name: interface-name
47791           in: path
47792           description: Name that identifies the physical interface
47793           required: true
47794           type: string
47795           example: __INTERFACE-NAME__
47796         - name: interface-name
47797           in: path
47798           description: Name given to the interface
47799           required: true
47800           type: string
47801           example: __INTERFACE-NAME__
47802         - name: l3-interface-ipv4-address
47803           in: path
47804           description: IP address
47805           required: true
47806           type: string
47807           example: __L3-INTERFACE-IPV4-ADDRESS__
47808         - name: body
47809           in: body
47810           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
47811           required: true
47812           schema:
47813             $ref: "#/definitions/relationship"
47814     delete:
47815       tags:
47816         - Network
47817       summary: delete an existing relationship
47818       description: delete an existing relationship
47819       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
47820       consumes:
47821         - application/json
47822         - application/xml
47823       produces:
47824         - application/json
47825         - application/xml
47826       responses:
47827         "default":
47828           description: Response codes found in [response codes](https://wiki.onap.org/).
47829       parameters:
47830         - name: pnf-name
47831           in: path
47832           description: unique name of Physical Network Function.
47833           required: true
47834           type: string
47835           example: __PNF-NAME__
47836         - name: interface-name
47837           in: path
47838           description: Name that identifies the physical interface
47839           required: true
47840           type: string
47841           example: __INTERFACE-NAME__
47842         - name: interface-name
47843           in: path
47844           description: Name given to the interface
47845           required: true
47846           type: string
47847           example: __INTERFACE-NAME__
47848         - name: l3-interface-ipv4-address
47849           in: path
47850           description: IP address
47851           required: true
47852           type: string
47853           example: __L3-INTERFACE-IPV4-ADDRESS__
47854   /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}:
47855     get:
47856       tags:
47857         - Network
47858       summary: returns l3-interface-ipv4-address-list
47859       description: returns l3-interface-ipv4-address-list
47860       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47861       produces:
47862         - application/json
47863         - application/xml
47864       responses:
47865         "200":
47866           description: successful operation
47867           schema:
47868               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
47869         "default":
47870           description: Response codes found in [response codes](https://wiki.onap.org/).
47871       parameters:
47872         - name: pnf-name
47873           in: path
47874           description: unique name of Physical Network Function.
47875           required: true
47876           type: string
47877           example: __PNF-NAME__
47878         - name: interface-name
47879           in: path
47880           description: Name that identifies the physical interface
47881           required: true
47882           type: string
47883           example: __INTERFACE-NAME__
47884         - name: interface-name
47885           in: path
47886           description: Name given to the interface
47887           required: true
47888           type: string
47889           example: __INTERFACE-NAME__
47890         - name: l3-interface-ipv4-address
47891           in: path
47892           description: IP address
47893           required: true
47894           type: string
47895           example: __L3-INTERFACE-IPV4-ADDRESS__
47896         - name: inv-status
47897           in: query
47898           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47899           required: false
47900           type: string
47901         - name: prov-status
47902           in: query
47903           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47904           required: false
47905           type: string
47906         - name: interface-id
47907           in: query
47908           description: ID of interface
47909           required: false
47910           type: string
47911         - name: macaddr
47912           in: query
47913           description: MAC address for the interface
47914           required: false
47915           type: string
47916         - name: network-name
47917           in: query
47918           description: Name of the network
47919           required: false
47920           type: string
47921         - name: vlan-id-inner
47922           in: query
47923           description: Inner VLAN tag
47924           required: false
47925           type: integer
47926           format: int64
47927         - name: neutron-network-id
47928           in: query
47929           description: Neutron network id of the interface that address belongs to
47930           required: false
47931           type: string
47932         - name: neutron-subnet-id
47933           in: query
47934           description: Neutron id of subnet that address belongs to
47935           required: false
47936           type: string
47937     put:
47938       tags:
47939         - Network
47940       summary: create or update an existing l3-interface-ipv4-address-list
47941       description: |
47942         Create or update an existing l3-interface-ipv4-address-list.
47943         #
47944         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
47945       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47946       consumes:
47947         - application/json
47948         - application/xml
47949       produces:
47950         - application/json
47951         - application/xml
47952       responses:
47953         "default":
47954           description: Response codes found in [response codes](https://wiki.onap.org/).
47955       parameters:
47956         - name: pnf-name
47957           in: path
47958           description: unique name of Physical Network Function.
47959           required: true
47960           type: string
47961           example: __PNF-NAME__
47962         - name: interface-name
47963           in: path
47964           description: Name that identifies the physical interface
47965           required: true
47966           type: string
47967           example: __INTERFACE-NAME__
47968         - name: interface-name
47969           in: path
47970           description: Name given to the interface
47971           required: true
47972           type: string
47973           example: __INTERFACE-NAME__
47974         - name: l3-interface-ipv4-address
47975           in: path
47976           description: IP address
47977           required: true
47978           type: string
47979           example: __L3-INTERFACE-IPV4-ADDRESS__
47980         - name: body
47981           in: body
47982           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
47983           required: true
47984           schema:
47985             $ref: "#/definitions/l3-interface-ipv4-address-list"
47986     patch:
47987       tags:
47988         - Network
47989       summary: update an existing l3-interface-ipv4-address-list
47990       description: |
47991         Update an existing l3-interface-ipv4-address-list
47992         #
47993         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47994         The PUT operation will entirely replace an existing object.
47995         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.
47996         #
47997         Other differences between PUT and PATCH are:
47998         #
47999         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48000         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48001         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48002       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
48003       consumes:
48004         - application/json
48005         - application/xml
48006       produces:
48007         - application/json
48008         - application/xml
48009       responses:
48010         "default":
48011           description: Response codes found in [response codes](https://wiki.onap.org/).
48012       parameters:
48013         - name: pnf-name
48014           in: path
48015           description: unique name of Physical Network Function.
48016           required: true
48017           type: string
48018           example: __PNF-NAME__
48019         - name: interface-name
48020           in: path
48021           description: Name that identifies the physical interface
48022           required: true
48023           type: string
48024           example: __INTERFACE-NAME__
48025         - name: interface-name
48026           in: path
48027           description: Name given to the interface
48028           required: true
48029           type: string
48030           example: __INTERFACE-NAME__
48031         - name: l3-interface-ipv4-address
48032           in: path
48033           description: IP address
48034           required: true
48035           type: string
48036           example: __L3-INTERFACE-IPV4-ADDRESS__
48037         - name: body
48038           in: body
48039           description: l3-interface-ipv4-address-list object that needs to be created or updated.
48040           required: true
48041           schema:
48042             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
48043     delete:
48044       tags:
48045         - Network
48046       summary: delete an existing l3-interface-ipv4-address-list
48047       description: delete an existing l3-interface-ipv4-address-list
48048       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
48049       consumes:
48050         - application/json
48051         - application/xml
48052       produces:
48053         - application/json
48054         - application/xml
48055       responses:
48056         "default":
48057           description: Response codes found in [response codes](https://wiki.onap.org/).
48058       parameters:
48059         - name: pnf-name
48060           in: path
48061           description: unique name of Physical Network Function.
48062           required: true
48063           type: string
48064           example: __PNF-NAME__
48065         - name: interface-name
48066           in: path
48067           description: Name that identifies the physical interface
48068           required: true
48069           type: string
48070           example: __INTERFACE-NAME__
48071         - name: interface-name
48072           in: path
48073           description: Name given to the interface
48074           required: true
48075           type: string
48076           example: __INTERFACE-NAME__
48077         - name: l3-interface-ipv4-address
48078           in: path
48079           description: IP address
48080           required: true
48081           type: string
48082           example: __L3-INTERFACE-IPV4-ADDRESS__
48083         - name: resource-version
48084           in: query
48085           description: resource-version for concurrency
48086           required: true
48087           type: string
48088   /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:
48089     put:
48090       tags:
48091         - Network
48092       summary: see node definition for valid relationships
48093       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
48094       consumes:
48095         - application/json
48096         - application/xml
48097       produces:
48098         - application/json
48099         - application/xml
48100       responses:
48101         "default":
48102           description: Response codes found in [response codes](https://wiki.onap.org/).
48103       parameters:
48104         - name: pnf-name
48105           in: path
48106           description: unique name of Physical Network Function.
48107           required: true
48108           type: string
48109           example: __PNF-NAME__
48110         - name: interface-name
48111           in: path
48112           description: Name that identifies the physical interface
48113           required: true
48114           type: string
48115           example: __INTERFACE-NAME__
48116         - name: interface-name
48117           in: path
48118           description: Name given to the interface
48119           required: true
48120           type: string
48121           example: __INTERFACE-NAME__
48122         - name: l3-interface-ipv6-address
48123           in: path
48124           description: IP address
48125           required: true
48126           type: string
48127           example: __L3-INTERFACE-IPV6-ADDRESS__
48128         - name: body
48129           in: body
48130           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
48131           required: true
48132           schema:
48133             $ref: "#/definitions/relationship"
48134     delete:
48135       tags:
48136         - Network
48137       summary: delete an existing relationship
48138       description: delete an existing relationship
48139       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
48140       consumes:
48141         - application/json
48142         - application/xml
48143       produces:
48144         - application/json
48145         - application/xml
48146       responses:
48147         "default":
48148           description: Response codes found in [response codes](https://wiki.onap.org/).
48149       parameters:
48150         - name: pnf-name
48151           in: path
48152           description: unique name of Physical Network Function.
48153           required: true
48154           type: string
48155           example: __PNF-NAME__
48156         - name: interface-name
48157           in: path
48158           description: Name that identifies the physical interface
48159           required: true
48160           type: string
48161           example: __INTERFACE-NAME__
48162         - name: interface-name
48163           in: path
48164           description: Name given to the interface
48165           required: true
48166           type: string
48167           example: __INTERFACE-NAME__
48168         - name: l3-interface-ipv6-address
48169           in: path
48170           description: IP address
48171           required: true
48172           type: string
48173           example: __L3-INTERFACE-IPV6-ADDRESS__
48174   /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}:
48175     get:
48176       tags:
48177         - Network
48178       summary: returns l3-interface-ipv6-address-list
48179       description: returns l3-interface-ipv6-address-list
48180       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48181       produces:
48182         - application/json
48183         - application/xml
48184       responses:
48185         "200":
48186           description: successful operation
48187           schema:
48188               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
48189         "default":
48190           description: Response codes found in [response codes](https://wiki.onap.org/).
48191       parameters:
48192         - name: pnf-name
48193           in: path
48194           description: unique name of Physical Network Function.
48195           required: true
48196           type: string
48197           example: __PNF-NAME__
48198         - name: interface-name
48199           in: path
48200           description: Name that identifies the physical interface
48201           required: true
48202           type: string
48203           example: __INTERFACE-NAME__
48204         - name: interface-name
48205           in: path
48206           description: Name given to the interface
48207           required: true
48208           type: string
48209           example: __INTERFACE-NAME__
48210         - name: l3-interface-ipv6-address
48211           in: path
48212           description: IP address
48213           required: true
48214           type: string
48215           example: __L3-INTERFACE-IPV6-ADDRESS__
48216         - name: inv-status
48217           in: query
48218           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48219           required: false
48220           type: string
48221         - name: prov-status
48222           in: query
48223           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48224           required: false
48225           type: string
48226         - name: interface-id
48227           in: query
48228           description: ID of interface
48229           required: false
48230           type: string
48231         - name: macaddr
48232           in: query
48233           description: MAC address for the interface
48234           required: false
48235           type: string
48236         - name: network-name
48237           in: query
48238           description: Name of the network
48239           required: false
48240           type: string
48241         - name: vlan-id-inner
48242           in: query
48243           description: Inner VLAN tag
48244           required: false
48245           type: integer
48246           format: int64
48247         - name: neutron-network-id
48248           in: query
48249           description: Neutron network id of the interface that address belongs to
48250           required: false
48251           type: string
48252         - name: neutron-subnet-id
48253           in: query
48254           description: Neutron id of subnet that address belongs to
48255           required: false
48256           type: string
48257     put:
48258       tags:
48259         - Network
48260       summary: create or update an existing l3-interface-ipv6-address-list
48261       description: |
48262         Create or update an existing l3-interface-ipv6-address-list.
48263         #
48264         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
48265       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48266       consumes:
48267         - application/json
48268         - application/xml
48269       produces:
48270         - application/json
48271         - application/xml
48272       responses:
48273         "default":
48274           description: Response codes found in [response codes](https://wiki.onap.org/).
48275       parameters:
48276         - name: pnf-name
48277           in: path
48278           description: unique name of Physical Network Function.
48279           required: true
48280           type: string
48281           example: __PNF-NAME__
48282         - name: interface-name
48283           in: path
48284           description: Name that identifies the physical interface
48285           required: true
48286           type: string
48287           example: __INTERFACE-NAME__
48288         - name: interface-name
48289           in: path
48290           description: Name given to the interface
48291           required: true
48292           type: string
48293           example: __INTERFACE-NAME__
48294         - name: l3-interface-ipv6-address
48295           in: path
48296           description: IP address
48297           required: true
48298           type: string
48299           example: __L3-INTERFACE-IPV6-ADDRESS__
48300         - name: body
48301           in: body
48302           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
48303           required: true
48304           schema:
48305             $ref: "#/definitions/l3-interface-ipv6-address-list"
48306     patch:
48307       tags:
48308         - Network
48309       summary: update an existing l3-interface-ipv6-address-list
48310       description: |
48311         Update an existing l3-interface-ipv6-address-list
48312         #
48313         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48314         The PUT operation will entirely replace an existing object.
48315         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.
48316         #
48317         Other differences between PUT and PATCH are:
48318         #
48319         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48320         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48321         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48322       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48323       consumes:
48324         - application/json
48325         - application/xml
48326       produces:
48327         - application/json
48328         - application/xml
48329       responses:
48330         "default":
48331           description: Response codes found in [response codes](https://wiki.onap.org/).
48332       parameters:
48333         - name: pnf-name
48334           in: path
48335           description: unique name of Physical Network Function.
48336           required: true
48337           type: string
48338           example: __PNF-NAME__
48339         - name: interface-name
48340           in: path
48341           description: Name that identifies the physical interface
48342           required: true
48343           type: string
48344           example: __INTERFACE-NAME__
48345         - name: interface-name
48346           in: path
48347           description: Name given to the interface
48348           required: true
48349           type: string
48350           example: __INTERFACE-NAME__
48351         - name: l3-interface-ipv6-address
48352           in: path
48353           description: IP address
48354           required: true
48355           type: string
48356           example: __L3-INTERFACE-IPV6-ADDRESS__
48357         - name: body
48358           in: body
48359           description: l3-interface-ipv6-address-list object that needs to be created or updated.
48360           required: true
48361           schema:
48362             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
48363     delete:
48364       tags:
48365         - Network
48366       summary: delete an existing l3-interface-ipv6-address-list
48367       description: delete an existing l3-interface-ipv6-address-list
48368       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
48369       consumes:
48370         - application/json
48371         - application/xml
48372       produces:
48373         - application/json
48374         - application/xml
48375       responses:
48376         "default":
48377           description: Response codes found in [response codes](https://wiki.onap.org/).
48378       parameters:
48379         - name: pnf-name
48380           in: path
48381           description: unique name of Physical Network Function.
48382           required: true
48383           type: string
48384           example: __PNF-NAME__
48385         - name: interface-name
48386           in: path
48387           description: Name that identifies the physical interface
48388           required: true
48389           type: string
48390           example: __INTERFACE-NAME__
48391         - name: interface-name
48392           in: path
48393           description: Name given to the interface
48394           required: true
48395           type: string
48396           example: __INTERFACE-NAME__
48397         - name: l3-interface-ipv6-address
48398           in: path
48399           description: IP address
48400           required: true
48401           type: string
48402           example: __L3-INTERFACE-IPV6-ADDRESS__
48403         - name: resource-version
48404           in: query
48405           description: resource-version for concurrency
48406           required: true
48407           type: string
48408   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
48409     get:
48410       tags:
48411         - Network
48412       summary: returns l-interface
48413       description: returns l-interface
48414       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48415       produces:
48416         - application/json
48417         - application/xml
48418       responses:
48419         "200":
48420           description: successful operation
48421           schema:
48422               $ref: "#/getDefinitions/l-interface"
48423         "default":
48424           description: Response codes found in [response codes](https://wiki.onap.org/).
48425       parameters:
48426         - name: pnf-name
48427           in: path
48428           description: unique name of Physical Network Function.
48429           required: true
48430           type: string
48431           example: __PNF-NAME__
48432         - name: interface-name
48433           in: path
48434           description: Name that identifies the physical interface
48435           required: true
48436           type: string
48437           example: __INTERFACE-NAME__
48438         - name: interface-name
48439           in: path
48440           description: Name given to the interface
48441           required: true
48442           type: string
48443           example: __INTERFACE-NAME__
48444         - name: inv-status
48445           in: query
48446           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48447           required: false
48448           type: string
48449         - name: prov-status
48450           in: query
48451           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48452           required: false
48453           type: string
48454         - name: interface-id
48455           in: query
48456           description: ID of interface
48457           required: false
48458           type: string
48459         - name: macaddr
48460           in: query
48461           description: MAC address for the interface
48462           required: false
48463           type: string
48464         - name: network-name
48465           in: query
48466           description: Name of the network
48467           required: false
48468           type: string
48469     put:
48470       tags:
48471         - Network
48472       summary: create or update an existing l-interface
48473       description: |
48474         Create or update an existing l-interface.
48475         #
48476         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
48477       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48478       consumes:
48479         - application/json
48480         - application/xml
48481       produces:
48482         - application/json
48483         - application/xml
48484       responses:
48485         "default":
48486           description: Response codes found in [response codes](https://wiki.onap.org/).
48487       parameters:
48488         - name: pnf-name
48489           in: path
48490           description: unique name of Physical Network Function.
48491           required: true
48492           type: string
48493           example: __PNF-NAME__
48494         - name: interface-name
48495           in: path
48496           description: Name that identifies the physical interface
48497           required: true
48498           type: string
48499           example: __INTERFACE-NAME__
48500         - name: interface-name
48501           in: path
48502           description: Name given to the interface
48503           required: true
48504           type: string
48505           example: __INTERFACE-NAME__
48506         - name: body
48507           in: body
48508           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
48509           required: true
48510           schema:
48511             $ref: "#/definitions/l-interface"
48512     patch:
48513       tags:
48514         - Network
48515       summary: update an existing l-interface
48516       description: |
48517         Update an existing l-interface
48518         #
48519         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48520         The PUT operation will entirely replace an existing object.
48521         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.
48522         #
48523         Other differences between PUT and PATCH are:
48524         #
48525         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48526         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48527         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48528       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48529       consumes:
48530         - application/json
48531         - application/xml
48532       produces:
48533         - application/json
48534         - application/xml
48535       responses:
48536         "default":
48537           description: Response codes found in [response codes](https://wiki.onap.org/).
48538       parameters:
48539         - name: pnf-name
48540           in: path
48541           description: unique name of Physical Network Function.
48542           required: true
48543           type: string
48544           example: __PNF-NAME__
48545         - name: interface-name
48546           in: path
48547           description: Name that identifies the physical interface
48548           required: true
48549           type: string
48550           example: __INTERFACE-NAME__
48551         - name: interface-name
48552           in: path
48553           description: Name given to the interface
48554           required: true
48555           type: string
48556           example: __INTERFACE-NAME__
48557         - name: body
48558           in: body
48559           description: l-interface object that needs to be created or updated.
48560           required: true
48561           schema:
48562             $ref: "#/patchDefinitions/l-interface"
48563     delete:
48564       tags:
48565         - Network
48566       summary: delete an existing l-interface
48567       description: delete an existing l-interface
48568       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
48569       consumes:
48570         - application/json
48571         - application/xml
48572       produces:
48573         - application/json
48574         - application/xml
48575       responses:
48576         "default":
48577           description: Response codes found in [response codes](https://wiki.onap.org/).
48578       parameters:
48579         - name: pnf-name
48580           in: path
48581           description: unique name of Physical Network Function.
48582           required: true
48583           type: string
48584           example: __PNF-NAME__
48585         - name: interface-name
48586           in: path
48587           description: Name that identifies the physical interface
48588           required: true
48589           type: string
48590           example: __INTERFACE-NAME__
48591         - name: interface-name
48592           in: path
48593           description: Name given to the interface
48594           required: true
48595           type: string
48596           example: __INTERFACE-NAME__
48597         - name: resource-version
48598           in: query
48599           description: resource-version for concurrency
48600           required: true
48601           type: string
48602   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
48603     get:
48604       tags:
48605         - Network
48606       summary: returns l-interfaces
48607       description: returns l-interfaces
48608       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
48609       produces:
48610         - application/json
48611         - application/xml
48612       responses:
48613         "200":
48614           description: successful operation
48615           schema:
48616               $ref: "#/getDefinitions/l-interfaces"
48617         "default":
48618           description: Response codes found in [response codes](https://wiki.onap.org/).
48619       parameters:
48620         - name: pnf-name
48621           in: path
48622           description: unique name of Physical Network Function.
48623           required: true
48624           type: string
48625           example: __PNF-NAME__
48626         - name: interface-name
48627           in: path
48628           description: Name that identifies the physical interface
48629           required: true
48630           type: string
48631           example: __INTERFACE-NAME__
48632         - name: inv-status
48633           in: query
48634           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48635           required: false
48636           type: string
48637         - name: prov-status
48638           in: query
48639           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48640           required: false
48641           type: string
48642   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
48643     get:
48644       tags:
48645         - Network
48646       summary: returns p-interface
48647       description: returns p-interface
48648       operationId: getNetworkPnfsPnfPInterfacesPInterface
48649       produces:
48650         - application/json
48651         - application/xml
48652       responses:
48653         "200":
48654           description: successful operation
48655           schema:
48656               $ref: "#/getDefinitions/p-interface"
48657         "default":
48658           description: Response codes found in [response codes](https://wiki.onap.org/).
48659       parameters:
48660         - name: pnf-name
48661           in: path
48662           description: unique name of Physical Network Function.
48663           required: true
48664           type: string
48665           example: __PNF-NAME__
48666         - name: interface-name
48667           in: path
48668           description: Name that identifies the physical interface
48669           required: true
48670           type: string
48671           example: __INTERFACE-NAME__
48672         - name: inv-status
48673           in: query
48674           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48675           required: false
48676           type: string
48677         - name: prov-status
48678           in: query
48679           description: Trigger for operational monitoring of this resource by Service Assurance systems.
48680           required: false
48681           type: string
48682     put:
48683       tags:
48684         - Network
48685       summary: create or update an existing p-interface
48686       description: |
48687         Create or update an existing p-interface.
48688         #
48689         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
48690       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
48691       consumes:
48692         - application/json
48693         - application/xml
48694       produces:
48695         - application/json
48696         - application/xml
48697       responses:
48698         "default":
48699           description: Response codes found in [response codes](https://wiki.onap.org/).
48700       parameters:
48701         - name: pnf-name
48702           in: path
48703           description: unique name of Physical Network Function.
48704           required: true
48705           type: string
48706           example: __PNF-NAME__
48707         - name: interface-name
48708           in: path
48709           description: Name that identifies the physical interface
48710           required: true
48711           type: string
48712           example: __INTERFACE-NAME__
48713         - name: body
48714           in: body
48715           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
48716           required: true
48717           schema:
48718             $ref: "#/definitions/p-interface"
48719     patch:
48720       tags:
48721         - Network
48722       summary: update an existing p-interface
48723       description: |
48724         Update an existing p-interface
48725         #
48726         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48727         The PUT operation will entirely replace an existing object.
48728         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.
48729         #
48730         Other differences between PUT and PATCH are:
48731         #
48732         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48733         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48734         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48735       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
48736       consumes:
48737         - application/json
48738         - application/xml
48739       produces:
48740         - application/json
48741         - application/xml
48742       responses:
48743         "default":
48744           description: Response codes found in [response codes](https://wiki.onap.org/).
48745       parameters:
48746         - name: pnf-name
48747           in: path
48748           description: unique name of Physical Network Function.
48749           required: true
48750           type: string
48751           example: __PNF-NAME__
48752         - name: interface-name
48753           in: path
48754           description: Name that identifies the physical interface
48755           required: true
48756           type: string
48757           example: __INTERFACE-NAME__
48758         - name: body
48759           in: body
48760           description: p-interface object that needs to be created or updated.
48761           required: true
48762           schema:
48763             $ref: "#/patchDefinitions/p-interface"
48764     delete:
48765       tags:
48766         - Network
48767       summary: delete an existing p-interface
48768       description: delete an existing p-interface
48769       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
48770       consumes:
48771         - application/json
48772         - application/xml
48773       produces:
48774         - application/json
48775         - application/xml
48776       responses:
48777         "default":
48778           description: Response codes found in [response codes](https://wiki.onap.org/).
48779       parameters:
48780         - name: pnf-name
48781           in: path
48782           description: unique name of Physical Network Function.
48783           required: true
48784           type: string
48785           example: __PNF-NAME__
48786         - name: interface-name
48787           in: path
48788           description: Name that identifies the physical interface
48789           required: true
48790           type: string
48791           example: __INTERFACE-NAME__
48792         - name: resource-version
48793           in: query
48794           description: resource-version for concurrency
48795           required: true
48796           type: string
48797   /network/pnfs/pnf/{pnf-name}/p-interfaces:
48798     get:
48799       tags:
48800         - Network
48801       summary: returns p-interfaces
48802       description: returns p-interfaces
48803       operationId: getNetworkPnfsPnfPInterfaces
48804       produces:
48805         - application/json
48806         - application/xml
48807       responses:
48808         "200":
48809           description: successful operation
48810           schema:
48811               $ref: "#/getDefinitions/p-interfaces"
48812         "default":
48813           description: Response codes found in [response codes](https://wiki.onap.org/).
48814       parameters:
48815         - name: pnf-name
48816           in: path
48817           description: unique name of Physical Network Function.
48818           required: true
48819           type: string
48820           example: __PNF-NAME__
48821         - name: inv-status
48822           in: query
48823           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48824           required: false
48825           type: string
48826   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
48827     put:
48828       tags:
48829         - Network
48830       summary: see node definition for valid relationships
48831       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
48832       consumes:
48833         - application/json
48834         - application/xml
48835       produces:
48836         - application/json
48837         - application/xml
48838       responses:
48839         "default":
48840           description: Response codes found in [response codes](https://wiki.onap.org/).
48841       parameters:
48842         - name: pnf-name
48843           in: path
48844           description: unique name of Physical Network Function.
48845           required: true
48846           type: string
48847           example: __PNF-NAME__
48848         - name: interface-name
48849           in: path
48850           description: Name that identifies the link aggregate interface
48851           required: true
48852           type: string
48853           example: __INTERFACE-NAME__
48854         - name: body
48855           in: body
48856           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
48857           required: true
48858           schema:
48859             $ref: "#/definitions/relationship"
48860     delete:
48861       tags:
48862         - Network
48863       summary: delete an existing relationship
48864       description: delete an existing relationship
48865       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
48866       consumes:
48867         - application/json
48868         - application/xml
48869       produces:
48870         - application/json
48871         - application/xml
48872       responses:
48873         "default":
48874           description: Response codes found in [response codes](https://wiki.onap.org/).
48875       parameters:
48876         - name: pnf-name
48877           in: path
48878           description: unique name of Physical Network Function.
48879           required: true
48880           type: string
48881           example: __PNF-NAME__
48882         - name: interface-name
48883           in: path
48884           description: Name that identifies the link aggregate interface
48885           required: true
48886           type: string
48887           example: __INTERFACE-NAME__
48888   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
48889     put:
48890       tags:
48891         - Network
48892       summary: see node definition for valid relationships
48893       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
48894       consumes:
48895         - application/json
48896         - application/xml
48897       produces:
48898         - application/json
48899         - application/xml
48900       responses:
48901         "default":
48902           description: Response codes found in [response codes](https://wiki.onap.org/).
48903       parameters:
48904         - name: pnf-name
48905           in: path
48906           description: unique name of Physical Network Function.
48907           required: true
48908           type: string
48909           example: __PNF-NAME__
48910         - name: interface-name
48911           in: path
48912           description: Name that identifies the link aggregate interface
48913           required: true
48914           type: string
48915           example: __INTERFACE-NAME__
48916         - name: interface-name
48917           in: path
48918           description: Name given to the interface
48919           required: true
48920           type: string
48921           example: __INTERFACE-NAME__
48922         - name: vlan-interface
48923           in: path
48924           description: String that identifies the interface
48925           required: true
48926           type: string
48927           example: __VLAN-INTERFACE__
48928         - name: body
48929           in: body
48930           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
48931           required: true
48932           schema:
48933             $ref: "#/definitions/relationship"
48934     delete:
48935       tags:
48936         - Network
48937       summary: delete an existing relationship
48938       description: delete an existing relationship
48939       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
48940       consumes:
48941         - application/json
48942         - application/xml
48943       produces:
48944         - application/json
48945         - application/xml
48946       responses:
48947         "default":
48948           description: Response codes found in [response codes](https://wiki.onap.org/).
48949       parameters:
48950         - name: pnf-name
48951           in: path
48952           description: unique name of Physical Network Function.
48953           required: true
48954           type: string
48955           example: __PNF-NAME__
48956         - name: interface-name
48957           in: path
48958           description: Name that identifies the link aggregate interface
48959           required: true
48960           type: string
48961           example: __INTERFACE-NAME__
48962         - name: interface-name
48963           in: path
48964           description: Name given to the interface
48965           required: true
48966           type: string
48967           example: __INTERFACE-NAME__
48968         - name: vlan-interface
48969           in: path
48970           description: String that identifies the interface
48971           required: true
48972           type: string
48973           example: __VLAN-INTERFACE__
48974   /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:
48975     put:
48976       tags:
48977         - Network
48978       summary: see node definition for valid relationships
48979       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48980       consumes:
48981         - application/json
48982         - application/xml
48983       produces:
48984         - application/json
48985         - application/xml
48986       responses:
48987         "default":
48988           description: Response codes found in [response codes](https://wiki.onap.org/).
48989       parameters:
48990         - name: pnf-name
48991           in: path
48992           description: unique name of Physical Network Function.
48993           required: true
48994           type: string
48995           example: __PNF-NAME__
48996         - name: interface-name
48997           in: path
48998           description: Name that identifies the link aggregate interface
48999           required: true
49000           type: string
49001           example: __INTERFACE-NAME__
49002         - name: interface-name
49003           in: path
49004           description: Name given to the interface
49005           required: true
49006           type: string
49007           example: __INTERFACE-NAME__
49008         - name: vlan-interface
49009           in: path
49010           description: String that identifies the interface
49011           required: true
49012           type: string
49013           example: __VLAN-INTERFACE__
49014         - name: l3-interface-ipv4-address
49015           in: path
49016           description: IP address
49017           required: true
49018           type: string
49019           example: __L3-INTERFACE-IPV4-ADDRESS__
49020         - name: body
49021           in: body
49022           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
49023           required: true
49024           schema:
49025             $ref: "#/definitions/relationship"
49026     delete:
49027       tags:
49028         - Network
49029       summary: delete an existing relationship
49030       description: delete an existing relationship
49031       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
49032       consumes:
49033         - application/json
49034         - application/xml
49035       produces:
49036         - application/json
49037         - application/xml
49038       responses:
49039         "default":
49040           description: Response codes found in [response codes](https://wiki.onap.org/).
49041       parameters:
49042         - name: pnf-name
49043           in: path
49044           description: unique name of Physical Network Function.
49045           required: true
49046           type: string
49047           example: __PNF-NAME__
49048         - name: interface-name
49049           in: path
49050           description: Name that identifies the link aggregate interface
49051           required: true
49052           type: string
49053           example: __INTERFACE-NAME__
49054         - name: interface-name
49055           in: path
49056           description: Name given to the interface
49057           required: true
49058           type: string
49059           example: __INTERFACE-NAME__
49060         - name: vlan-interface
49061           in: path
49062           description: String that identifies the interface
49063           required: true
49064           type: string
49065           example: __VLAN-INTERFACE__
49066         - name: l3-interface-ipv4-address
49067           in: path
49068           description: IP address
49069           required: true
49070           type: string
49071           example: __L3-INTERFACE-IPV4-ADDRESS__
49072   /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}:
49073     get:
49074       tags:
49075         - Network
49076       summary: returns l3-interface-ipv4-address-list
49077       description: returns l3-interface-ipv4-address-list
49078       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49079       produces:
49080         - application/json
49081         - application/xml
49082       responses:
49083         "200":
49084           description: successful operation
49085           schema:
49086               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49087         "default":
49088           description: Response codes found in [response codes](https://wiki.onap.org/).
49089       parameters:
49090         - name: pnf-name
49091           in: path
49092           description: unique name of Physical Network Function.
49093           required: true
49094           type: string
49095           example: __PNF-NAME__
49096         - name: interface-name
49097           in: path
49098           description: Name that identifies the link aggregate interface
49099           required: true
49100           type: string
49101           example: __INTERFACE-NAME__
49102         - name: interface-name
49103           in: path
49104           description: Name given to the interface
49105           required: true
49106           type: string
49107           example: __INTERFACE-NAME__
49108         - name: vlan-interface
49109           in: path
49110           description: String that identifies the interface
49111           required: true
49112           type: string
49113           example: __VLAN-INTERFACE__
49114         - name: l3-interface-ipv4-address
49115           in: path
49116           description: IP address
49117           required: true
49118           type: string
49119           example: __L3-INTERFACE-IPV4-ADDRESS__
49120         - name: inv-status
49121           in: query
49122           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49123           required: false
49124           type: string
49125         - name: interface-id
49126           in: query
49127           description: ID of interface
49128           required: false
49129           type: string
49130         - name: interface-role
49131           in: query
49132           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49133           required: false
49134           type: string
49135         - name: interface-id
49136           in: query
49137           description: ID of interface
49138           required: false
49139           type: string
49140         - name: macaddr
49141           in: query
49142           description: MAC address for the interface
49143           required: false
49144           type: string
49145         - name: network-name
49146           in: query
49147           description: Name of the network
49148           required: false
49149           type: string
49150         - name: vlan-id-inner
49151           in: query
49152           description: Inner VLAN tag
49153           required: false
49154           type: integer
49155           format: int64
49156         - name: vpn-key
49157           in: query
49158           description: This indicates the customers VPN ID associated with this vlan
49159           required: false
49160           type: string
49161         - name: vlan-id-inner
49162           in: query
49163           description: Inner VLAN tag
49164           required: false
49165           type: integer
49166           format: int64
49167         - name: neutron-network-id
49168           in: query
49169           description: Neutron network id of the interface that address belongs to
49170           required: false
49171           type: string
49172         - name: neutron-subnet-id
49173           in: query
49174           description: Neutron id of subnet that address belongs to
49175           required: false
49176           type: string
49177     put:
49178       tags:
49179         - Network
49180       summary: create or update an existing l3-interface-ipv4-address-list
49181       description: |
49182         Create or update an existing l3-interface-ipv4-address-list.
49183         #
49184         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
49185       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49186       consumes:
49187         - application/json
49188         - application/xml
49189       produces:
49190         - application/json
49191         - application/xml
49192       responses:
49193         "default":
49194           description: Response codes found in [response codes](https://wiki.onap.org/).
49195       parameters:
49196         - name: pnf-name
49197           in: path
49198           description: unique name of Physical Network Function.
49199           required: true
49200           type: string
49201           example: __PNF-NAME__
49202         - name: interface-name
49203           in: path
49204           description: Name that identifies the link aggregate interface
49205           required: true
49206           type: string
49207           example: __INTERFACE-NAME__
49208         - name: interface-name
49209           in: path
49210           description: Name given to the interface
49211           required: true
49212           type: string
49213           example: __INTERFACE-NAME__
49214         - name: vlan-interface
49215           in: path
49216           description: String that identifies the interface
49217           required: true
49218           type: string
49219           example: __VLAN-INTERFACE__
49220         - name: l3-interface-ipv4-address
49221           in: path
49222           description: IP address
49223           required: true
49224           type: string
49225           example: __L3-INTERFACE-IPV4-ADDRESS__
49226         - name: body
49227           in: body
49228           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
49229           required: true
49230           schema:
49231             $ref: "#/definitions/l3-interface-ipv4-address-list"
49232     patch:
49233       tags:
49234         - Network
49235       summary: update an existing l3-interface-ipv4-address-list
49236       description: |
49237         Update an existing l3-interface-ipv4-address-list
49238         #
49239         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49240         The PUT operation will entirely replace an existing object.
49241         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.
49242         #
49243         Other differences between PUT and PATCH are:
49244         #
49245         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49246         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49247         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49248       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49249       consumes:
49250         - application/json
49251         - application/xml
49252       produces:
49253         - application/json
49254         - application/xml
49255       responses:
49256         "default":
49257           description: Response codes found in [response codes](https://wiki.onap.org/).
49258       parameters:
49259         - name: pnf-name
49260           in: path
49261           description: unique name of Physical Network Function.
49262           required: true
49263           type: string
49264           example: __PNF-NAME__
49265         - name: interface-name
49266           in: path
49267           description: Name that identifies the link aggregate interface
49268           required: true
49269           type: string
49270           example: __INTERFACE-NAME__
49271         - name: interface-name
49272           in: path
49273           description: Name given to the interface
49274           required: true
49275           type: string
49276           example: __INTERFACE-NAME__
49277         - name: vlan-interface
49278           in: path
49279           description: String that identifies the interface
49280           required: true
49281           type: string
49282           example: __VLAN-INTERFACE__
49283         - name: l3-interface-ipv4-address
49284           in: path
49285           description: IP address
49286           required: true
49287           type: string
49288           example: __L3-INTERFACE-IPV4-ADDRESS__
49289         - name: body
49290           in: body
49291           description: l3-interface-ipv4-address-list object that needs to be created or updated.
49292           required: true
49293           schema:
49294             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
49295     delete:
49296       tags:
49297         - Network
49298       summary: delete an existing l3-interface-ipv4-address-list
49299       description: delete an existing l3-interface-ipv4-address-list
49300       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
49301       consumes:
49302         - application/json
49303         - application/xml
49304       produces:
49305         - application/json
49306         - application/xml
49307       responses:
49308         "default":
49309           description: Response codes found in [response codes](https://wiki.onap.org/).
49310       parameters:
49311         - name: pnf-name
49312           in: path
49313           description: unique name of Physical Network Function.
49314           required: true
49315           type: string
49316           example: __PNF-NAME__
49317         - name: interface-name
49318           in: path
49319           description: Name that identifies the link aggregate interface
49320           required: true
49321           type: string
49322           example: __INTERFACE-NAME__
49323         - name: interface-name
49324           in: path
49325           description: Name given to the interface
49326           required: true
49327           type: string
49328           example: __INTERFACE-NAME__
49329         - name: vlan-interface
49330           in: path
49331           description: String that identifies the interface
49332           required: true
49333           type: string
49334           example: __VLAN-INTERFACE__
49335         - name: l3-interface-ipv4-address
49336           in: path
49337           description: IP address
49338           required: true
49339           type: string
49340           example: __L3-INTERFACE-IPV4-ADDRESS__
49341         - name: resource-version
49342           in: query
49343           description: resource-version for concurrency
49344           required: true
49345           type: string
49346   /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:
49347     put:
49348       tags:
49349         - Network
49350       summary: see node definition for valid relationships
49351       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
49352       consumes:
49353         - application/json
49354         - application/xml
49355       produces:
49356         - application/json
49357         - application/xml
49358       responses:
49359         "default":
49360           description: Response codes found in [response codes](https://wiki.onap.org/).
49361       parameters:
49362         - name: pnf-name
49363           in: path
49364           description: unique name of Physical Network Function.
49365           required: true
49366           type: string
49367           example: __PNF-NAME__
49368         - name: interface-name
49369           in: path
49370           description: Name that identifies the link aggregate interface
49371           required: true
49372           type: string
49373           example: __INTERFACE-NAME__
49374         - name: interface-name
49375           in: path
49376           description: Name given to the interface
49377           required: true
49378           type: string
49379           example: __INTERFACE-NAME__
49380         - name: vlan-interface
49381           in: path
49382           description: String that identifies the interface
49383           required: true
49384           type: string
49385           example: __VLAN-INTERFACE__
49386         - name: l3-interface-ipv6-address
49387           in: path
49388           description: IP address
49389           required: true
49390           type: string
49391           example: __L3-INTERFACE-IPV6-ADDRESS__
49392         - name: body
49393           in: body
49394           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
49395           required: true
49396           schema:
49397             $ref: "#/definitions/relationship"
49398     delete:
49399       tags:
49400         - Network
49401       summary: delete an existing relationship
49402       description: delete an existing relationship
49403       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
49404       consumes:
49405         - application/json
49406         - application/xml
49407       produces:
49408         - application/json
49409         - application/xml
49410       responses:
49411         "default":
49412           description: Response codes found in [response codes](https://wiki.onap.org/).
49413       parameters:
49414         - name: pnf-name
49415           in: path
49416           description: unique name of Physical Network Function.
49417           required: true
49418           type: string
49419           example: __PNF-NAME__
49420         - name: interface-name
49421           in: path
49422           description: Name that identifies the link aggregate interface
49423           required: true
49424           type: string
49425           example: __INTERFACE-NAME__
49426         - name: interface-name
49427           in: path
49428           description: Name given to the interface
49429           required: true
49430           type: string
49431           example: __INTERFACE-NAME__
49432         - name: vlan-interface
49433           in: path
49434           description: String that identifies the interface
49435           required: true
49436           type: string
49437           example: __VLAN-INTERFACE__
49438         - name: l3-interface-ipv6-address
49439           in: path
49440           description: IP address
49441           required: true
49442           type: string
49443           example: __L3-INTERFACE-IPV6-ADDRESS__
49444   /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}:
49445     get:
49446       tags:
49447         - Network
49448       summary: returns l3-interface-ipv6-address-list
49449       description: returns l3-interface-ipv6-address-list
49450       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49451       produces:
49452         - application/json
49453         - application/xml
49454       responses:
49455         "200":
49456           description: successful operation
49457           schema:
49458               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
49459         "default":
49460           description: Response codes found in [response codes](https://wiki.onap.org/).
49461       parameters:
49462         - name: pnf-name
49463           in: path
49464           description: unique name of Physical Network Function.
49465           required: true
49466           type: string
49467           example: __PNF-NAME__
49468         - name: interface-name
49469           in: path
49470           description: Name that identifies the link aggregate interface
49471           required: true
49472           type: string
49473           example: __INTERFACE-NAME__
49474         - name: interface-name
49475           in: path
49476           description: Name given to the interface
49477           required: true
49478           type: string
49479           example: __INTERFACE-NAME__
49480         - name: vlan-interface
49481           in: path
49482           description: String that identifies the interface
49483           required: true
49484           type: string
49485           example: __VLAN-INTERFACE__
49486         - name: l3-interface-ipv6-address
49487           in: path
49488           description: IP address
49489           required: true
49490           type: string
49491           example: __L3-INTERFACE-IPV6-ADDRESS__
49492         - name: inv-status
49493           in: query
49494           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49495           required: false
49496           type: string
49497         - name: interface-id
49498           in: query
49499           description: ID of interface
49500           required: false
49501           type: string
49502         - name: interface-role
49503           in: query
49504           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49505           required: false
49506           type: string
49507         - name: interface-id
49508           in: query
49509           description: ID of interface
49510           required: false
49511           type: string
49512         - name: macaddr
49513           in: query
49514           description: MAC address for the interface
49515           required: false
49516           type: string
49517         - name: network-name
49518           in: query
49519           description: Name of the network
49520           required: false
49521           type: string
49522         - name: vlan-id-inner
49523           in: query
49524           description: Inner VLAN tag
49525           required: false
49526           type: integer
49527           format: int64
49528         - name: vpn-key
49529           in: query
49530           description: This indicates the customers VPN ID associated with this vlan
49531           required: false
49532           type: string
49533         - name: vlan-id-inner
49534           in: query
49535           description: Inner VLAN tag
49536           required: false
49537           type: integer
49538           format: int64
49539         - name: neutron-network-id
49540           in: query
49541           description: Neutron network id of the interface that address belongs to
49542           required: false
49543           type: string
49544         - name: neutron-subnet-id
49545           in: query
49546           description: Neutron id of subnet that address belongs to
49547           required: false
49548           type: string
49549     put:
49550       tags:
49551         - Network
49552       summary: create or update an existing l3-interface-ipv6-address-list
49553       description: |
49554         Create or update an existing l3-interface-ipv6-address-list.
49555         #
49556         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
49557       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49558       consumes:
49559         - application/json
49560         - application/xml
49561       produces:
49562         - application/json
49563         - application/xml
49564       responses:
49565         "default":
49566           description: Response codes found in [response codes](https://wiki.onap.org/).
49567       parameters:
49568         - name: pnf-name
49569           in: path
49570           description: unique name of Physical Network Function.
49571           required: true
49572           type: string
49573           example: __PNF-NAME__
49574         - name: interface-name
49575           in: path
49576           description: Name that identifies the link aggregate interface
49577           required: true
49578           type: string
49579           example: __INTERFACE-NAME__
49580         - name: interface-name
49581           in: path
49582           description: Name given to the interface
49583           required: true
49584           type: string
49585           example: __INTERFACE-NAME__
49586         - name: vlan-interface
49587           in: path
49588           description: String that identifies the interface
49589           required: true
49590           type: string
49591           example: __VLAN-INTERFACE__
49592         - name: l3-interface-ipv6-address
49593           in: path
49594           description: IP address
49595           required: true
49596           type: string
49597           example: __L3-INTERFACE-IPV6-ADDRESS__
49598         - name: body
49599           in: body
49600           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
49601           required: true
49602           schema:
49603             $ref: "#/definitions/l3-interface-ipv6-address-list"
49604     patch:
49605       tags:
49606         - Network
49607       summary: update an existing l3-interface-ipv6-address-list
49608       description: |
49609         Update an existing l3-interface-ipv6-address-list
49610         #
49611         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49612         The PUT operation will entirely replace an existing object.
49613         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.
49614         #
49615         Other differences between PUT and PATCH are:
49616         #
49617         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49618         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49619         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49620       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49621       consumes:
49622         - application/json
49623         - application/xml
49624       produces:
49625         - application/json
49626         - application/xml
49627       responses:
49628         "default":
49629           description: Response codes found in [response codes](https://wiki.onap.org/).
49630       parameters:
49631         - name: pnf-name
49632           in: path
49633           description: unique name of Physical Network Function.
49634           required: true
49635           type: string
49636           example: __PNF-NAME__
49637         - name: interface-name
49638           in: path
49639           description: Name that identifies the link aggregate interface
49640           required: true
49641           type: string
49642           example: __INTERFACE-NAME__
49643         - name: interface-name
49644           in: path
49645           description: Name given to the interface
49646           required: true
49647           type: string
49648           example: __INTERFACE-NAME__
49649         - name: vlan-interface
49650           in: path
49651           description: String that identifies the interface
49652           required: true
49653           type: string
49654           example: __VLAN-INTERFACE__
49655         - name: l3-interface-ipv6-address
49656           in: path
49657           description: IP address
49658           required: true
49659           type: string
49660           example: __L3-INTERFACE-IPV6-ADDRESS__
49661         - name: body
49662           in: body
49663           description: l3-interface-ipv6-address-list object that needs to be created or updated.
49664           required: true
49665           schema:
49666             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
49667     delete:
49668       tags:
49669         - Network
49670       summary: delete an existing l3-interface-ipv6-address-list
49671       description: delete an existing l3-interface-ipv6-address-list
49672       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
49673       consumes:
49674         - application/json
49675         - application/xml
49676       produces:
49677         - application/json
49678         - application/xml
49679       responses:
49680         "default":
49681           description: Response codes found in [response codes](https://wiki.onap.org/).
49682       parameters:
49683         - name: pnf-name
49684           in: path
49685           description: unique name of Physical Network Function.
49686           required: true
49687           type: string
49688           example: __PNF-NAME__
49689         - name: interface-name
49690           in: path
49691           description: Name that identifies the link aggregate interface
49692           required: true
49693           type: string
49694           example: __INTERFACE-NAME__
49695         - name: interface-name
49696           in: path
49697           description: Name given to the interface
49698           required: true
49699           type: string
49700           example: __INTERFACE-NAME__
49701         - name: vlan-interface
49702           in: path
49703           description: String that identifies the interface
49704           required: true
49705           type: string
49706           example: __VLAN-INTERFACE__
49707         - name: l3-interface-ipv6-address
49708           in: path
49709           description: IP address
49710           required: true
49711           type: string
49712           example: __L3-INTERFACE-IPV6-ADDRESS__
49713         - name: resource-version
49714           in: query
49715           description: resource-version for concurrency
49716           required: true
49717           type: string
49718   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
49719     get:
49720       tags:
49721         - Network
49722       summary: returns vlan
49723       description: returns vlan
49724       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
49725       produces:
49726         - application/json
49727         - application/xml
49728       responses:
49729         "200":
49730           description: successful operation
49731           schema:
49732               $ref: "#/getDefinitions/vlan"
49733         "default":
49734           description: Response codes found in [response codes](https://wiki.onap.org/).
49735       parameters:
49736         - name: pnf-name
49737           in: path
49738           description: unique name of Physical Network Function.
49739           required: true
49740           type: string
49741           example: __PNF-NAME__
49742         - name: interface-name
49743           in: path
49744           description: Name that identifies the link aggregate interface
49745           required: true
49746           type: string
49747           example: __INTERFACE-NAME__
49748         - name: interface-name
49749           in: path
49750           description: Name given to the interface
49751           required: true
49752           type: string
49753           example: __INTERFACE-NAME__
49754         - name: vlan-interface
49755           in: path
49756           description: String that identifies the interface
49757           required: true
49758           type: string
49759           example: __VLAN-INTERFACE__
49760         - name: inv-status
49761           in: query
49762           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49763           required: false
49764           type: string
49765         - name: interface-id
49766           in: query
49767           description: ID of interface
49768           required: false
49769           type: string
49770         - name: interface-role
49771           in: query
49772           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49773           required: false
49774           type: string
49775         - name: interface-id
49776           in: query
49777           description: ID of interface
49778           required: false
49779           type: string
49780         - name: macaddr
49781           in: query
49782           description: MAC address for the interface
49783           required: false
49784           type: string
49785         - name: network-name
49786           in: query
49787           description: Name of the network
49788           required: false
49789           type: string
49790         - name: vlan-id-inner
49791           in: query
49792           description: Inner VLAN tag
49793           required: false
49794           type: integer
49795           format: int64
49796         - name: vpn-key
49797           in: query
49798           description: This indicates the customers VPN ID associated with this vlan
49799           required: false
49800           type: string
49801     put:
49802       tags:
49803         - Network
49804       summary: create or update an existing vlan
49805       description: |
49806         Create or update an existing vlan.
49807         #
49808         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
49809       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
49810       consumes:
49811         - application/json
49812         - application/xml
49813       produces:
49814         - application/json
49815         - application/xml
49816       responses:
49817         "default":
49818           description: Response codes found in [response codes](https://wiki.onap.org/).
49819       parameters:
49820         - name: pnf-name
49821           in: path
49822           description: unique name of Physical Network Function.
49823           required: true
49824           type: string
49825           example: __PNF-NAME__
49826         - name: interface-name
49827           in: path
49828           description: Name that identifies the link aggregate interface
49829           required: true
49830           type: string
49831           example: __INTERFACE-NAME__
49832         - name: interface-name
49833           in: path
49834           description: Name given to the interface
49835           required: true
49836           type: string
49837           example: __INTERFACE-NAME__
49838         - name: vlan-interface
49839           in: path
49840           description: String that identifies the interface
49841           required: true
49842           type: string
49843           example: __VLAN-INTERFACE__
49844         - name: body
49845           in: body
49846           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
49847           required: true
49848           schema:
49849             $ref: "#/definitions/vlan"
49850     patch:
49851       tags:
49852         - Network
49853       summary: update an existing vlan
49854       description: |
49855         Update an existing vlan
49856         #
49857         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49858         The PUT operation will entirely replace an existing object.
49859         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.
49860         #
49861         Other differences between PUT and PATCH are:
49862         #
49863         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49864         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49865         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49866       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
49867       consumes:
49868         - application/json
49869         - application/xml
49870       produces:
49871         - application/json
49872         - application/xml
49873       responses:
49874         "default":
49875           description: Response codes found in [response codes](https://wiki.onap.org/).
49876       parameters:
49877         - name: pnf-name
49878           in: path
49879           description: unique name of Physical Network Function.
49880           required: true
49881           type: string
49882           example: __PNF-NAME__
49883         - name: interface-name
49884           in: path
49885           description: Name that identifies the link aggregate interface
49886           required: true
49887           type: string
49888           example: __INTERFACE-NAME__
49889         - name: interface-name
49890           in: path
49891           description: Name given to the interface
49892           required: true
49893           type: string
49894           example: __INTERFACE-NAME__
49895         - name: vlan-interface
49896           in: path
49897           description: String that identifies the interface
49898           required: true
49899           type: string
49900           example: __VLAN-INTERFACE__
49901         - name: body
49902           in: body
49903           description: vlan object that needs to be created or updated.
49904           required: true
49905           schema:
49906             $ref: "#/patchDefinitions/vlan"
49907     delete:
49908       tags:
49909         - Network
49910       summary: delete an existing vlan
49911       description: delete an existing vlan
49912       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
49913       consumes:
49914         - application/json
49915         - application/xml
49916       produces:
49917         - application/json
49918         - application/xml
49919       responses:
49920         "default":
49921           description: Response codes found in [response codes](https://wiki.onap.org/).
49922       parameters:
49923         - name: pnf-name
49924           in: path
49925           description: unique name of Physical Network Function.
49926           required: true
49927           type: string
49928           example: __PNF-NAME__
49929         - name: interface-name
49930           in: path
49931           description: Name that identifies the link aggregate interface
49932           required: true
49933           type: string
49934           example: __INTERFACE-NAME__
49935         - name: interface-name
49936           in: path
49937           description: Name given to the interface
49938           required: true
49939           type: string
49940           example: __INTERFACE-NAME__
49941         - name: vlan-interface
49942           in: path
49943           description: String that identifies the interface
49944           required: true
49945           type: string
49946           example: __VLAN-INTERFACE__
49947         - name: resource-version
49948           in: query
49949           description: resource-version for concurrency
49950           required: true
49951           type: string
49952   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
49953     get:
49954       tags:
49955         - Network
49956       summary: returns vlans
49957       description: returns vlans
49958       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
49959       produces:
49960         - application/json
49961         - application/xml
49962       responses:
49963         "200":
49964           description: successful operation
49965           schema:
49966               $ref: "#/getDefinitions/vlans"
49967         "default":
49968           description: Response codes found in [response codes](https://wiki.onap.org/).
49969       parameters:
49970         - name: pnf-name
49971           in: path
49972           description: unique name of Physical Network Function.
49973           required: true
49974           type: string
49975           example: __PNF-NAME__
49976         - name: interface-name
49977           in: path
49978           description: Name that identifies the link aggregate interface
49979           required: true
49980           type: string
49981           example: __INTERFACE-NAME__
49982         - name: interface-name
49983           in: path
49984           description: Name given to the interface
49985           required: true
49986           type: string
49987           example: __INTERFACE-NAME__
49988         - name: inv-status
49989           in: query
49990           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49991           required: false
49992           type: string
49993         - name: interface-id
49994           in: query
49995           description: ID of interface
49996           required: false
49997           type: string
49998         - name: interface-role
49999           in: query
50000           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50001           required: false
50002           type: string
50003         - name: interface-id
50004           in: query
50005           description: ID of interface
50006           required: false
50007           type: string
50008         - name: macaddr
50009           in: query
50010           description: MAC address for the interface
50011           required: false
50012           type: string
50013         - name: network-name
50014           in: query
50015           description: Name of the network
50016           required: false
50017           type: string
50018   /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:
50019     put:
50020       tags:
50021         - Network
50022       summary: see node definition for valid relationships
50023       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
50024       consumes:
50025         - application/json
50026         - application/xml
50027       produces:
50028         - application/json
50029         - application/xml
50030       responses:
50031         "default":
50032           description: Response codes found in [response codes](https://wiki.onap.org/).
50033       parameters:
50034         - name: pnf-name
50035           in: path
50036           description: unique name of Physical Network Function.
50037           required: true
50038           type: string
50039           example: __PNF-NAME__
50040         - name: interface-name
50041           in: path
50042           description: Name that identifies the link aggregate interface
50043           required: true
50044           type: string
50045           example: __INTERFACE-NAME__
50046         - name: interface-name
50047           in: path
50048           description: Name given to the interface
50049           required: true
50050           type: string
50051           example: __INTERFACE-NAME__
50052         - name: pci-id
50053           in: path
50054           description: PCI ID used to identify the sriov-vf
50055           required: true
50056           type: string
50057           example: __PCI-ID__
50058         - name: body
50059           in: body
50060           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
50061           required: true
50062           schema:
50063             $ref: "#/definitions/relationship"
50064     delete:
50065       tags:
50066         - Network
50067       summary: delete an existing relationship
50068       description: delete an existing relationship
50069       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
50070       consumes:
50071         - application/json
50072         - application/xml
50073       produces:
50074         - application/json
50075         - application/xml
50076       responses:
50077         "default":
50078           description: Response codes found in [response codes](https://wiki.onap.org/).
50079       parameters:
50080         - name: pnf-name
50081           in: path
50082           description: unique name of Physical Network Function.
50083           required: true
50084           type: string
50085           example: __PNF-NAME__
50086         - name: interface-name
50087           in: path
50088           description: Name that identifies the link aggregate interface
50089           required: true
50090           type: string
50091           example: __INTERFACE-NAME__
50092         - name: interface-name
50093           in: path
50094           description: Name given to the interface
50095           required: true
50096           type: string
50097           example: __INTERFACE-NAME__
50098         - name: pci-id
50099           in: path
50100           description: PCI ID used to identify the sriov-vf
50101           required: true
50102           type: string
50103           example: __PCI-ID__
50104   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
50105     get:
50106       tags:
50107         - Network
50108       summary: returns sriov-vf
50109       description: returns sriov-vf
50110       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50111       produces:
50112         - application/json
50113         - application/xml
50114       responses:
50115         "200":
50116           description: successful operation
50117           schema:
50118               $ref: "#/getDefinitions/sriov-vf"
50119         "default":
50120           description: Response codes found in [response codes](https://wiki.onap.org/).
50121       parameters:
50122         - name: pnf-name
50123           in: path
50124           description: unique name of Physical Network Function.
50125           required: true
50126           type: string
50127           example: __PNF-NAME__
50128         - name: interface-name
50129           in: path
50130           description: Name that identifies the link aggregate interface
50131           required: true
50132           type: string
50133           example: __INTERFACE-NAME__
50134         - name: interface-name
50135           in: path
50136           description: Name given to the interface
50137           required: true
50138           type: string
50139           example: __INTERFACE-NAME__
50140         - name: pci-id
50141           in: path
50142           description: PCI ID used to identify the sriov-vf
50143           required: true
50144           type: string
50145           example: __PCI-ID__
50146         - name: inv-status
50147           in: query
50148           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50149           required: false
50150           type: string
50151         - name: interface-id
50152           in: query
50153           description: ID of interface
50154           required: false
50155           type: string
50156         - name: interface-role
50157           in: query
50158           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50159           required: false
50160           type: string
50161         - name: interface-id
50162           in: query
50163           description: ID of interface
50164           required: false
50165           type: string
50166         - name: macaddr
50167           in: query
50168           description: MAC address for the interface
50169           required: false
50170           type: string
50171         - name: network-name
50172           in: query
50173           description: Name of the network
50174           required: false
50175           type: string
50176         - name: vf-vlan-filter
50177           in: query
50178           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
50179           required: false
50180           type: string
50181         - name: vf-mac-filter
50182           in: query
50183           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
50184           required: false
50185           type: string
50186         - name: vf-vlan-strip
50187           in: query
50188           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
50189           required: false
50190           type: boolean
50191         - name: neutron-network-id
50192           in: query
50193           description: Neutron network id of the interface
50194           required: false
50195           type: string
50196     put:
50197       tags:
50198         - Network
50199       summary: create or update an existing sriov-vf
50200       description: |
50201         Create or update an existing sriov-vf.
50202         #
50203         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
50204       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50205       consumes:
50206         - application/json
50207         - application/xml
50208       produces:
50209         - application/json
50210         - application/xml
50211       responses:
50212         "default":
50213           description: Response codes found in [response codes](https://wiki.onap.org/).
50214       parameters:
50215         - name: pnf-name
50216           in: path
50217           description: unique name of Physical Network Function.
50218           required: true
50219           type: string
50220           example: __PNF-NAME__
50221         - name: interface-name
50222           in: path
50223           description: Name that identifies the link aggregate interface
50224           required: true
50225           type: string
50226           example: __INTERFACE-NAME__
50227         - name: interface-name
50228           in: path
50229           description: Name given to the interface
50230           required: true
50231           type: string
50232           example: __INTERFACE-NAME__
50233         - name: pci-id
50234           in: path
50235           description: PCI ID used to identify the sriov-vf
50236           required: true
50237           type: string
50238           example: __PCI-ID__
50239         - name: body
50240           in: body
50241           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
50242           required: true
50243           schema:
50244             $ref: "#/definitions/sriov-vf"
50245     patch:
50246       tags:
50247         - Network
50248       summary: update an existing sriov-vf
50249       description: |
50250         Update an existing sriov-vf
50251         #
50252         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50253         The PUT operation will entirely replace an existing object.
50254         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.
50255         #
50256         Other differences between PUT and PATCH are:
50257         #
50258         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50259         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50260         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50261       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50262       consumes:
50263         - application/json
50264         - application/xml
50265       produces:
50266         - application/json
50267         - application/xml
50268       responses:
50269         "default":
50270           description: Response codes found in [response codes](https://wiki.onap.org/).
50271       parameters:
50272         - name: pnf-name
50273           in: path
50274           description: unique name of Physical Network Function.
50275           required: true
50276           type: string
50277           example: __PNF-NAME__
50278         - name: interface-name
50279           in: path
50280           description: Name that identifies the link aggregate interface
50281           required: true
50282           type: string
50283           example: __INTERFACE-NAME__
50284         - name: interface-name
50285           in: path
50286           description: Name given to the interface
50287           required: true
50288           type: string
50289           example: __INTERFACE-NAME__
50290         - name: pci-id
50291           in: path
50292           description: PCI ID used to identify the sriov-vf
50293           required: true
50294           type: string
50295           example: __PCI-ID__
50296         - name: body
50297           in: body
50298           description: sriov-vf object that needs to be created or updated.
50299           required: true
50300           schema:
50301             $ref: "#/patchDefinitions/sriov-vf"
50302     delete:
50303       tags:
50304         - Network
50305       summary: delete an existing sriov-vf
50306       description: delete an existing sriov-vf
50307       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
50308       consumes:
50309         - application/json
50310         - application/xml
50311       produces:
50312         - application/json
50313         - application/xml
50314       responses:
50315         "default":
50316           description: Response codes found in [response codes](https://wiki.onap.org/).
50317       parameters:
50318         - name: pnf-name
50319           in: path
50320           description: unique name of Physical Network Function.
50321           required: true
50322           type: string
50323           example: __PNF-NAME__
50324         - name: interface-name
50325           in: path
50326           description: Name that identifies the link aggregate interface
50327           required: true
50328           type: string
50329           example: __INTERFACE-NAME__
50330         - name: interface-name
50331           in: path
50332           description: Name given to the interface
50333           required: true
50334           type: string
50335           example: __INTERFACE-NAME__
50336         - name: pci-id
50337           in: path
50338           description: PCI ID used to identify the sriov-vf
50339           required: true
50340           type: string
50341           example: __PCI-ID__
50342         - name: resource-version
50343           in: query
50344           description: resource-version for concurrency
50345           required: true
50346           type: string
50347   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
50348     get:
50349       tags:
50350         - Network
50351       summary: returns sriov-vfs
50352       description: returns sriov-vfs
50353       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
50354       produces:
50355         - application/json
50356         - application/xml
50357       responses:
50358         "200":
50359           description: successful operation
50360           schema:
50361               $ref: "#/getDefinitions/sriov-vfs"
50362         "default":
50363           description: Response codes found in [response codes](https://wiki.onap.org/).
50364       parameters:
50365         - name: pnf-name
50366           in: path
50367           description: unique name of Physical Network Function.
50368           required: true
50369           type: string
50370           example: __PNF-NAME__
50371         - name: interface-name
50372           in: path
50373           description: Name that identifies the link aggregate interface
50374           required: true
50375           type: string
50376           example: __INTERFACE-NAME__
50377         - name: interface-name
50378           in: path
50379           description: Name given to the interface
50380           required: true
50381           type: string
50382           example: __INTERFACE-NAME__
50383         - name: inv-status
50384           in: query
50385           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50386           required: false
50387           type: string
50388         - name: interface-id
50389           in: query
50390           description: ID of interface
50391           required: false
50392           type: string
50393         - name: interface-role
50394           in: query
50395           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50396           required: false
50397           type: string
50398         - name: interface-id
50399           in: query
50400           description: ID of interface
50401           required: false
50402           type: string
50403         - name: macaddr
50404           in: query
50405           description: MAC address for the interface
50406           required: false
50407           type: string
50408         - name: network-name
50409           in: query
50410           description: Name of the network
50411           required: false
50412           type: string
50413   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
50414     put:
50415       tags:
50416         - Network
50417       summary: see node definition for valid relationships
50418       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
50419       consumes:
50420         - application/json
50421         - application/xml
50422       produces:
50423         - application/json
50424         - application/xml
50425       responses:
50426         "default":
50427           description: Response codes found in [response codes](https://wiki.onap.org/).
50428       parameters:
50429         - name: pnf-name
50430           in: path
50431           description: unique name of Physical Network Function.
50432           required: true
50433           type: string
50434           example: __PNF-NAME__
50435         - name: interface-name
50436           in: path
50437           description: Name that identifies the link aggregate interface
50438           required: true
50439           type: string
50440           example: __INTERFACE-NAME__
50441         - name: interface-name
50442           in: path
50443           description: Name given to the interface
50444           required: true
50445           type: string
50446           example: __INTERFACE-NAME__
50447         - name: body
50448           in: body
50449           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
50450           required: true
50451           schema:
50452             $ref: "#/definitions/relationship"
50453     delete:
50454       tags:
50455         - Network
50456       summary: delete an existing relationship
50457       description: delete an existing relationship
50458       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
50459       consumes:
50460         - application/json
50461         - application/xml
50462       produces:
50463         - application/json
50464         - application/xml
50465       responses:
50466         "default":
50467           description: Response codes found in [response codes](https://wiki.onap.org/).
50468       parameters:
50469         - name: pnf-name
50470           in: path
50471           description: unique name of Physical Network Function.
50472           required: true
50473           type: string
50474           example: __PNF-NAME__
50475         - name: interface-name
50476           in: path
50477           description: Name that identifies the link aggregate interface
50478           required: true
50479           type: string
50480           example: __INTERFACE-NAME__
50481         - name: interface-name
50482           in: path
50483           description: Name given to the interface
50484           required: true
50485           type: string
50486           example: __INTERFACE-NAME__
50487   /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:
50488     put:
50489       tags:
50490         - Network
50491       summary: see node definition for valid relationships
50492       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
50493       consumes:
50494         - application/json
50495         - application/xml
50496       produces:
50497         - application/json
50498         - application/xml
50499       responses:
50500         "default":
50501           description: Response codes found in [response codes](https://wiki.onap.org/).
50502       parameters:
50503         - name: pnf-name
50504           in: path
50505           description: unique name of Physical Network Function.
50506           required: true
50507           type: string
50508           example: __PNF-NAME__
50509         - name: interface-name
50510           in: path
50511           description: Name that identifies the link aggregate interface
50512           required: true
50513           type: string
50514           example: __INTERFACE-NAME__
50515         - name: interface-name
50516           in: path
50517           description: Name given to the interface
50518           required: true
50519           type: string
50520           example: __INTERFACE-NAME__
50521         - name: l3-interface-ipv4-address
50522           in: path
50523           description: IP address
50524           required: true
50525           type: string
50526           example: __L3-INTERFACE-IPV4-ADDRESS__
50527         - name: body
50528           in: body
50529           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
50530           required: true
50531           schema:
50532             $ref: "#/definitions/relationship"
50533     delete:
50534       tags:
50535         - Network
50536       summary: delete an existing relationship
50537       description: delete an existing relationship
50538       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
50539       consumes:
50540         - application/json
50541         - application/xml
50542       produces:
50543         - application/json
50544         - application/xml
50545       responses:
50546         "default":
50547           description: Response codes found in [response codes](https://wiki.onap.org/).
50548       parameters:
50549         - name: pnf-name
50550           in: path
50551           description: unique name of Physical Network Function.
50552           required: true
50553           type: string
50554           example: __PNF-NAME__
50555         - name: interface-name
50556           in: path
50557           description: Name that identifies the link aggregate interface
50558           required: true
50559           type: string
50560           example: __INTERFACE-NAME__
50561         - name: interface-name
50562           in: path
50563           description: Name given to the interface
50564           required: true
50565           type: string
50566           example: __INTERFACE-NAME__
50567         - name: l3-interface-ipv4-address
50568           in: path
50569           description: IP address
50570           required: true
50571           type: string
50572           example: __L3-INTERFACE-IPV4-ADDRESS__
50573   /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}:
50574     get:
50575       tags:
50576         - Network
50577       summary: returns l3-interface-ipv4-address-list
50578       description: returns l3-interface-ipv4-address-list
50579       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
50580       produces:
50581         - application/json
50582         - application/xml
50583       responses:
50584         "200":
50585           description: successful operation
50586           schema:
50587               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
50588         "default":
50589           description: Response codes found in [response codes](https://wiki.onap.org/).
50590       parameters:
50591         - name: pnf-name
50592           in: path
50593           description: unique name of Physical Network Function.
50594           required: true
50595           type: string
50596           example: __PNF-NAME__
50597         - name: interface-name
50598           in: path
50599           description: Name that identifies the link aggregate interface
50600           required: true
50601           type: string
50602           example: __INTERFACE-NAME__
50603         - name: interface-name
50604           in: path
50605           description: Name given to the interface
50606           required: true
50607           type: string
50608           example: __INTERFACE-NAME__
50609         - name: l3-interface-ipv4-address
50610           in: path
50611           description: IP address
50612           required: true
50613           type: string
50614           example: __L3-INTERFACE-IPV4-ADDRESS__
50615         - name: inv-status
50616           in: query
50617           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50618           required: false
50619           type: string
50620         - name: interface-id
50621           in: query
50622           description: ID of interface
50623           required: false
50624           type: string
50625         - name: interface-role
50626           in: query
50627           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50628           required: false
50629           type: string
50630         - name: interface-id
50631           in: query
50632           description: ID of interface
50633           required: false
50634           type: string
50635         - name: macaddr
50636           in: query
50637           description: MAC address for the interface
50638           required: false
50639           type: string
50640         - name: network-name
50641           in: query
50642           description: Name of the network
50643           required: false
50644           type: string
50645         - name: vlan-id-inner
50646           in: query
50647           description: Inner VLAN tag
50648           required: false
50649           type: integer
50650           format: int64
50651         - name: neutron-network-id
50652           in: query
50653           description: Neutron network id of the interface that address belongs to
50654           required: false
50655           type: string
50656         - name: neutron-subnet-id
50657           in: query
50658           description: Neutron id of subnet that address belongs to
50659           required: false
50660           type: string
50661     put:
50662       tags:
50663         - Network
50664       summary: create or update an existing l3-interface-ipv4-address-list
50665       description: |
50666         Create or update an existing l3-interface-ipv4-address-list.
50667         #
50668         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
50669       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
50670       consumes:
50671         - application/json
50672         - application/xml
50673       produces:
50674         - application/json
50675         - application/xml
50676       responses:
50677         "default":
50678           description: Response codes found in [response codes](https://wiki.onap.org/).
50679       parameters:
50680         - name: pnf-name
50681           in: path
50682           description: unique name of Physical Network Function.
50683           required: true
50684           type: string
50685           example: __PNF-NAME__
50686         - name: interface-name
50687           in: path
50688           description: Name that identifies the link aggregate interface
50689           required: true
50690           type: string
50691           example: __INTERFACE-NAME__
50692         - name: interface-name
50693           in: path
50694           description: Name given to the interface
50695           required: true
50696           type: string
50697           example: __INTERFACE-NAME__
50698         - name: l3-interface-ipv4-address
50699           in: path
50700           description: IP address
50701           required: true
50702           type: string
50703           example: __L3-INTERFACE-IPV4-ADDRESS__
50704         - name: body
50705           in: body
50706           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
50707           required: true
50708           schema:
50709             $ref: "#/definitions/l3-interface-ipv4-address-list"
50710     patch:
50711       tags:
50712         - Network
50713       summary: update an existing l3-interface-ipv4-address-list
50714       description: |
50715         Update an existing l3-interface-ipv4-address-list
50716         #
50717         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50718         The PUT operation will entirely replace an existing object.
50719         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.
50720         #
50721         Other differences between PUT and PATCH are:
50722         #
50723         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50724         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50725         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50726       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
50727       consumes:
50728         - application/json
50729         - application/xml
50730       produces:
50731         - application/json
50732         - application/xml
50733       responses:
50734         "default":
50735           description: Response codes found in [response codes](https://wiki.onap.org/).
50736       parameters:
50737         - name: pnf-name
50738           in: path
50739           description: unique name of Physical Network Function.
50740           required: true
50741           type: string
50742           example: __PNF-NAME__
50743         - name: interface-name
50744           in: path
50745           description: Name that identifies the link aggregate interface
50746           required: true
50747           type: string
50748           example: __INTERFACE-NAME__
50749         - name: interface-name
50750           in: path
50751           description: Name given to the interface
50752           required: true
50753           type: string
50754           example: __INTERFACE-NAME__
50755         - name: l3-interface-ipv4-address
50756           in: path
50757           description: IP address
50758           required: true
50759           type: string
50760           example: __L3-INTERFACE-IPV4-ADDRESS__
50761         - name: body
50762           in: body
50763           description: l3-interface-ipv4-address-list object that needs to be created or updated.
50764           required: true
50765           schema:
50766             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
50767     delete:
50768       tags:
50769         - Network
50770       summary: delete an existing l3-interface-ipv4-address-list
50771       description: delete an existing l3-interface-ipv4-address-list
50772       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
50773       consumes:
50774         - application/json
50775         - application/xml
50776       produces:
50777         - application/json
50778         - application/xml
50779       responses:
50780         "default":
50781           description: Response codes found in [response codes](https://wiki.onap.org/).
50782       parameters:
50783         - name: pnf-name
50784           in: path
50785           description: unique name of Physical Network Function.
50786           required: true
50787           type: string
50788           example: __PNF-NAME__
50789         - name: interface-name
50790           in: path
50791           description: Name that identifies the link aggregate interface
50792           required: true
50793           type: string
50794           example: __INTERFACE-NAME__
50795         - name: interface-name
50796           in: path
50797           description: Name given to the interface
50798           required: true
50799           type: string
50800           example: __INTERFACE-NAME__
50801         - name: l3-interface-ipv4-address
50802           in: path
50803           description: IP address
50804           required: true
50805           type: string
50806           example: __L3-INTERFACE-IPV4-ADDRESS__
50807         - name: resource-version
50808           in: query
50809           description: resource-version for concurrency
50810           required: true
50811           type: string
50812   /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:
50813     put:
50814       tags:
50815         - Network
50816       summary: see node definition for valid relationships
50817       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
50818       consumes:
50819         - application/json
50820         - application/xml
50821       produces:
50822         - application/json
50823         - application/xml
50824       responses:
50825         "default":
50826           description: Response codes found in [response codes](https://wiki.onap.org/).
50827       parameters:
50828         - name: pnf-name
50829           in: path
50830           description: unique name of Physical Network Function.
50831           required: true
50832           type: string
50833           example: __PNF-NAME__
50834         - name: interface-name
50835           in: path
50836           description: Name that identifies the link aggregate interface
50837           required: true
50838           type: string
50839           example: __INTERFACE-NAME__
50840         - name: interface-name
50841           in: path
50842           description: Name given to the interface
50843           required: true
50844           type: string
50845           example: __INTERFACE-NAME__
50846         - name: l3-interface-ipv6-address
50847           in: path
50848           description: IP address
50849           required: true
50850           type: string
50851           example: __L3-INTERFACE-IPV6-ADDRESS__
50852         - name: body
50853           in: body
50854           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
50855           required: true
50856           schema:
50857             $ref: "#/definitions/relationship"
50858     delete:
50859       tags:
50860         - Network
50861       summary: delete an existing relationship
50862       description: delete an existing relationship
50863       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
50864       consumes:
50865         - application/json
50866         - application/xml
50867       produces:
50868         - application/json
50869         - application/xml
50870       responses:
50871         "default":
50872           description: Response codes found in [response codes](https://wiki.onap.org/).
50873       parameters:
50874         - name: pnf-name
50875           in: path
50876           description: unique name of Physical Network Function.
50877           required: true
50878           type: string
50879           example: __PNF-NAME__
50880         - name: interface-name
50881           in: path
50882           description: Name that identifies the link aggregate interface
50883           required: true
50884           type: string
50885           example: __INTERFACE-NAME__
50886         - name: interface-name
50887           in: path
50888           description: Name given to the interface
50889           required: true
50890           type: string
50891           example: __INTERFACE-NAME__
50892         - name: l3-interface-ipv6-address
50893           in: path
50894           description: IP address
50895           required: true
50896           type: string
50897           example: __L3-INTERFACE-IPV6-ADDRESS__
50898   /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}:
50899     get:
50900       tags:
50901         - Network
50902       summary: returns l3-interface-ipv6-address-list
50903       description: returns l3-interface-ipv6-address-list
50904       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50905       produces:
50906         - application/json
50907         - application/xml
50908       responses:
50909         "200":
50910           description: successful operation
50911           schema:
50912               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
50913         "default":
50914           description: Response codes found in [response codes](https://wiki.onap.org/).
50915       parameters:
50916         - name: pnf-name
50917           in: path
50918           description: unique name of Physical Network Function.
50919           required: true
50920           type: string
50921           example: __PNF-NAME__
50922         - name: interface-name
50923           in: path
50924           description: Name that identifies the link aggregate interface
50925           required: true
50926           type: string
50927           example: __INTERFACE-NAME__
50928         - name: interface-name
50929           in: path
50930           description: Name given to the interface
50931           required: true
50932           type: string
50933           example: __INTERFACE-NAME__
50934         - name: l3-interface-ipv6-address
50935           in: path
50936           description: IP address
50937           required: true
50938           type: string
50939           example: __L3-INTERFACE-IPV6-ADDRESS__
50940         - name: inv-status
50941           in: query
50942           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50943           required: false
50944           type: string
50945         - name: interface-id
50946           in: query
50947           description: ID of interface
50948           required: false
50949           type: string
50950         - name: interface-role
50951           in: query
50952           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50953           required: false
50954           type: string
50955         - name: interface-id
50956           in: query
50957           description: ID of interface
50958           required: false
50959           type: string
50960         - name: macaddr
50961           in: query
50962           description: MAC address for the interface
50963           required: false
50964           type: string
50965         - name: network-name
50966           in: query
50967           description: Name of the network
50968           required: false
50969           type: string
50970         - name: vlan-id-inner
50971           in: query
50972           description: Inner VLAN tag
50973           required: false
50974           type: integer
50975           format: int64
50976         - name: neutron-network-id
50977           in: query
50978           description: Neutron network id of the interface that address belongs to
50979           required: false
50980           type: string
50981         - name: neutron-subnet-id
50982           in: query
50983           description: Neutron id of subnet that address belongs to
50984           required: false
50985           type: string
50986     put:
50987       tags:
50988         - Network
50989       summary: create or update an existing l3-interface-ipv6-address-list
50990       description: |
50991         Create or update an existing l3-interface-ipv6-address-list.
50992         #
50993         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
50994       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50995       consumes:
50996         - application/json
50997         - application/xml
50998       produces:
50999         - application/json
51000         - application/xml
51001       responses:
51002         "default":
51003           description: Response codes found in [response codes](https://wiki.onap.org/).
51004       parameters:
51005         - name: pnf-name
51006           in: path
51007           description: unique name of Physical Network Function.
51008           required: true
51009           type: string
51010           example: __PNF-NAME__
51011         - name: interface-name
51012           in: path
51013           description: Name that identifies the link aggregate interface
51014           required: true
51015           type: string
51016           example: __INTERFACE-NAME__
51017         - name: interface-name
51018           in: path
51019           description: Name given to the interface
51020           required: true
51021           type: string
51022           example: __INTERFACE-NAME__
51023         - name: l3-interface-ipv6-address
51024           in: path
51025           description: IP address
51026           required: true
51027           type: string
51028           example: __L3-INTERFACE-IPV6-ADDRESS__
51029         - name: body
51030           in: body
51031           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
51032           required: true
51033           schema:
51034             $ref: "#/definitions/l3-interface-ipv6-address-list"
51035     patch:
51036       tags:
51037         - Network
51038       summary: update an existing l3-interface-ipv6-address-list
51039       description: |
51040         Update an existing l3-interface-ipv6-address-list
51041         #
51042         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51043         The PUT operation will entirely replace an existing object.
51044         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.
51045         #
51046         Other differences between PUT and PATCH are:
51047         #
51048         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51049         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51050         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51051       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
51052       consumes:
51053         - application/json
51054         - application/xml
51055       produces:
51056         - application/json
51057         - application/xml
51058       responses:
51059         "default":
51060           description: Response codes found in [response codes](https://wiki.onap.org/).
51061       parameters:
51062         - name: pnf-name
51063           in: path
51064           description: unique name of Physical Network Function.
51065           required: true
51066           type: string
51067           example: __PNF-NAME__
51068         - name: interface-name
51069           in: path
51070           description: Name that identifies the link aggregate interface
51071           required: true
51072           type: string
51073           example: __INTERFACE-NAME__
51074         - name: interface-name
51075           in: path
51076           description: Name given to the interface
51077           required: true
51078           type: string
51079           example: __INTERFACE-NAME__
51080         - name: l3-interface-ipv6-address
51081           in: path
51082           description: IP address
51083           required: true
51084           type: string
51085           example: __L3-INTERFACE-IPV6-ADDRESS__
51086         - name: body
51087           in: body
51088           description: l3-interface-ipv6-address-list object that needs to be created or updated.
51089           required: true
51090           schema:
51091             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
51092     delete:
51093       tags:
51094         - Network
51095       summary: delete an existing l3-interface-ipv6-address-list
51096       description: delete an existing l3-interface-ipv6-address-list
51097       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
51098       consumes:
51099         - application/json
51100         - application/xml
51101       produces:
51102         - application/json
51103         - application/xml
51104       responses:
51105         "default":
51106           description: Response codes found in [response codes](https://wiki.onap.org/).
51107       parameters:
51108         - name: pnf-name
51109           in: path
51110           description: unique name of Physical Network Function.
51111           required: true
51112           type: string
51113           example: __PNF-NAME__
51114         - name: interface-name
51115           in: path
51116           description: Name that identifies the link aggregate interface
51117           required: true
51118           type: string
51119           example: __INTERFACE-NAME__
51120         - name: interface-name
51121           in: path
51122           description: Name given to the interface
51123           required: true
51124           type: string
51125           example: __INTERFACE-NAME__
51126         - name: l3-interface-ipv6-address
51127           in: path
51128           description: IP address
51129           required: true
51130           type: string
51131           example: __L3-INTERFACE-IPV6-ADDRESS__
51132         - name: resource-version
51133           in: query
51134           description: resource-version for concurrency
51135           required: true
51136           type: string
51137   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
51138     get:
51139       tags:
51140         - Network
51141       summary: returns l-interface
51142       description: returns l-interface
51143       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51144       produces:
51145         - application/json
51146         - application/xml
51147       responses:
51148         "200":
51149           description: successful operation
51150           schema:
51151               $ref: "#/getDefinitions/l-interface"
51152         "default":
51153           description: Response codes found in [response codes](https://wiki.onap.org/).
51154       parameters:
51155         - name: pnf-name
51156           in: path
51157           description: unique name of Physical Network Function.
51158           required: true
51159           type: string
51160           example: __PNF-NAME__
51161         - name: interface-name
51162           in: path
51163           description: Name that identifies the link aggregate interface
51164           required: true
51165           type: string
51166           example: __INTERFACE-NAME__
51167         - name: interface-name
51168           in: path
51169           description: Name given to the interface
51170           required: true
51171           type: string
51172           example: __INTERFACE-NAME__
51173         - name: inv-status
51174           in: query
51175           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51176           required: false
51177           type: string
51178         - name: interface-id
51179           in: query
51180           description: ID of interface
51181           required: false
51182           type: string
51183         - name: interface-role
51184           in: query
51185           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51186           required: false
51187           type: string
51188         - name: interface-id
51189           in: query
51190           description: ID of interface
51191           required: false
51192           type: string
51193         - name: macaddr
51194           in: query
51195           description: MAC address for the interface
51196           required: false
51197           type: string
51198         - name: network-name
51199           in: query
51200           description: Name of the network
51201           required: false
51202           type: string
51203     put:
51204       tags:
51205         - Network
51206       summary: create or update an existing l-interface
51207       description: |
51208         Create or update an existing l-interface.
51209         #
51210         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
51211       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51212       consumes:
51213         - application/json
51214         - application/xml
51215       produces:
51216         - application/json
51217         - application/xml
51218       responses:
51219         "default":
51220           description: Response codes found in [response codes](https://wiki.onap.org/).
51221       parameters:
51222         - name: pnf-name
51223           in: path
51224           description: unique name of Physical Network Function.
51225           required: true
51226           type: string
51227           example: __PNF-NAME__
51228         - name: interface-name
51229           in: path
51230           description: Name that identifies the link aggregate interface
51231           required: true
51232           type: string
51233           example: __INTERFACE-NAME__
51234         - name: interface-name
51235           in: path
51236           description: Name given to the interface
51237           required: true
51238           type: string
51239           example: __INTERFACE-NAME__
51240         - name: body
51241           in: body
51242           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
51243           required: true
51244           schema:
51245             $ref: "#/definitions/l-interface"
51246     patch:
51247       tags:
51248         - Network
51249       summary: update an existing l-interface
51250       description: |
51251         Update an existing l-interface
51252         #
51253         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51254         The PUT operation will entirely replace an existing object.
51255         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.
51256         #
51257         Other differences between PUT and PATCH are:
51258         #
51259         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51260         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51261         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51262       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51263       consumes:
51264         - application/json
51265         - application/xml
51266       produces:
51267         - application/json
51268         - application/xml
51269       responses:
51270         "default":
51271           description: Response codes found in [response codes](https://wiki.onap.org/).
51272       parameters:
51273         - name: pnf-name
51274           in: path
51275           description: unique name of Physical Network Function.
51276           required: true
51277           type: string
51278           example: __PNF-NAME__
51279         - name: interface-name
51280           in: path
51281           description: Name that identifies the link aggregate interface
51282           required: true
51283           type: string
51284           example: __INTERFACE-NAME__
51285         - name: interface-name
51286           in: path
51287           description: Name given to the interface
51288           required: true
51289           type: string
51290           example: __INTERFACE-NAME__
51291         - name: body
51292           in: body
51293           description: l-interface object that needs to be created or updated.
51294           required: true
51295           schema:
51296             $ref: "#/patchDefinitions/l-interface"
51297     delete:
51298       tags:
51299         - Network
51300       summary: delete an existing l-interface
51301       description: delete an existing l-interface
51302       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
51303       consumes:
51304         - application/json
51305         - application/xml
51306       produces:
51307         - application/json
51308         - application/xml
51309       responses:
51310         "default":
51311           description: Response codes found in [response codes](https://wiki.onap.org/).
51312       parameters:
51313         - name: pnf-name
51314           in: path
51315           description: unique name of Physical Network Function.
51316           required: true
51317           type: string
51318           example: __PNF-NAME__
51319         - name: interface-name
51320           in: path
51321           description: Name that identifies the link aggregate interface
51322           required: true
51323           type: string
51324           example: __INTERFACE-NAME__
51325         - name: interface-name
51326           in: path
51327           description: Name given to the interface
51328           required: true
51329           type: string
51330           example: __INTERFACE-NAME__
51331         - name: resource-version
51332           in: query
51333           description: resource-version for concurrency
51334           required: true
51335           type: string
51336   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
51337     get:
51338       tags:
51339         - Network
51340       summary: returns l-interfaces
51341       description: returns l-interfaces
51342       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
51343       produces:
51344         - application/json
51345         - application/xml
51346       responses:
51347         "200":
51348           description: successful operation
51349           schema:
51350               $ref: "#/getDefinitions/l-interfaces"
51351         "default":
51352           description: Response codes found in [response codes](https://wiki.onap.org/).
51353       parameters:
51354         - name: pnf-name
51355           in: path
51356           description: unique name of Physical Network Function.
51357           required: true
51358           type: string
51359           example: __PNF-NAME__
51360         - name: interface-name
51361           in: path
51362           description: Name that identifies the link aggregate interface
51363           required: true
51364           type: string
51365           example: __INTERFACE-NAME__
51366         - name: inv-status
51367           in: query
51368           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51369           required: false
51370           type: string
51371         - name: interface-id
51372           in: query
51373           description: ID of interface
51374           required: false
51375           type: string
51376         - name: interface-role
51377           in: query
51378           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51379           required: false
51380           type: string
51381   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
51382     get:
51383       tags:
51384         - Network
51385       summary: returns lag-interface
51386       description: returns lag-interface
51387       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
51388       produces:
51389         - application/json
51390         - application/xml
51391       responses:
51392         "200":
51393           description: successful operation
51394           schema:
51395               $ref: "#/getDefinitions/lag-interface"
51396         "default":
51397           description: Response codes found in [response codes](https://wiki.onap.org/).
51398       parameters:
51399         - name: pnf-name
51400           in: path
51401           description: unique name of Physical Network Function.
51402           required: true
51403           type: string
51404           example: __PNF-NAME__
51405         - name: interface-name
51406           in: path
51407           description: Name that identifies the link aggregate interface
51408           required: true
51409           type: string
51410           example: __INTERFACE-NAME__
51411         - name: inv-status
51412           in: query
51413           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51414           required: false
51415           type: string
51416         - name: interface-id
51417           in: query
51418           description: ID of interface
51419           required: false
51420           type: string
51421         - name: interface-role
51422           in: query
51423           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51424           required: false
51425           type: string
51426     put:
51427       tags:
51428         - Network
51429       summary: create or update an existing lag-interface
51430       description: |
51431         Create or update an existing lag-interface.
51432         #
51433         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
51434       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
51435       consumes:
51436         - application/json
51437         - application/xml
51438       produces:
51439         - application/json
51440         - application/xml
51441       responses:
51442         "default":
51443           description: Response codes found in [response codes](https://wiki.onap.org/).
51444       parameters:
51445         - name: pnf-name
51446           in: path
51447           description: unique name of Physical Network Function.
51448           required: true
51449           type: string
51450           example: __PNF-NAME__
51451         - name: interface-name
51452           in: path
51453           description: Name that identifies the link aggregate interface
51454           required: true
51455           type: string
51456           example: __INTERFACE-NAME__
51457         - name: body
51458           in: body
51459           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
51460           required: true
51461           schema:
51462             $ref: "#/definitions/lag-interface"
51463     patch:
51464       tags:
51465         - Network
51466       summary: update an existing lag-interface
51467       description: |
51468         Update an existing lag-interface
51469         #
51470         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51471         The PUT operation will entirely replace an existing object.
51472         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.
51473         #
51474         Other differences between PUT and PATCH are:
51475         #
51476         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51477         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51478         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51479       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
51480       consumes:
51481         - application/json
51482         - application/xml
51483       produces:
51484         - application/json
51485         - application/xml
51486       responses:
51487         "default":
51488           description: Response codes found in [response codes](https://wiki.onap.org/).
51489       parameters:
51490         - name: pnf-name
51491           in: path
51492           description: unique name of Physical Network Function.
51493           required: true
51494           type: string
51495           example: __PNF-NAME__
51496         - name: interface-name
51497           in: path
51498           description: Name that identifies the link aggregate interface
51499           required: true
51500           type: string
51501           example: __INTERFACE-NAME__
51502         - name: body
51503           in: body
51504           description: lag-interface object that needs to be created or updated.
51505           required: true
51506           schema:
51507             $ref: "#/patchDefinitions/lag-interface"
51508     delete:
51509       tags:
51510         - Network
51511       summary: delete an existing lag-interface
51512       description: delete an existing lag-interface
51513       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
51514       consumes:
51515         - application/json
51516         - application/xml
51517       produces:
51518         - application/json
51519         - application/xml
51520       responses:
51521         "default":
51522           description: Response codes found in [response codes](https://wiki.onap.org/).
51523       parameters:
51524         - name: pnf-name
51525           in: path
51526           description: unique name of Physical Network Function.
51527           required: true
51528           type: string
51529           example: __PNF-NAME__
51530         - name: interface-name
51531           in: path
51532           description: Name that identifies the link aggregate interface
51533           required: true
51534           type: string
51535           example: __INTERFACE-NAME__
51536         - name: resource-version
51537           in: query
51538           description: resource-version for concurrency
51539           required: true
51540           type: string
51541   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
51542     get:
51543       tags:
51544         - Network
51545       summary: returns lag-interfaces
51546       description: returns lag-interfaces
51547       operationId: getNetworkPnfsPnfLagInterfaces
51548       produces:
51549         - application/json
51550         - application/xml
51551       responses:
51552         "200":
51553           description: successful operation
51554           schema:
51555               $ref: "#/getDefinitions/lag-interfaces"
51556         "default":
51557           description: Response codes found in [response codes](https://wiki.onap.org/).
51558       parameters:
51559         - name: pnf-name
51560           in: path
51561           description: unique name of Physical Network Function.
51562           required: true
51563           type: string
51564           example: __PNF-NAME__
51565         - name: inv-status
51566           in: query
51567           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51568           required: false
51569           type: string
51570   /network/pnfs/pnf/{pnf-name}:
51571     get:
51572       tags:
51573         - Network
51574       summary: returns pnf
51575       description: returns pnf
51576       operationId: getNetworkPnfsPnf
51577       produces:
51578         - application/json
51579         - application/xml
51580       responses:
51581         "200":
51582           description: successful operation
51583           schema:
51584               $ref: "#/getDefinitions/pnf"
51585         "default":
51586           description: Response codes found in [response codes](https://wiki.onap.org/).
51587       parameters:
51588         - name: pnf-name
51589           in: path
51590           description: unique name of Physical Network Function.
51591           required: true
51592           type: string
51593           example: __PNF-NAME__
51594         - name: inv-status
51595           in: query
51596           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51597           required: false
51598           type: string
51599     put:
51600       tags:
51601         - Network
51602       summary: create or update an existing pnf
51603       description: |
51604         Create or update an existing pnf.
51605         #
51606         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
51607       operationId: createOrUpdateNetworkPnfsPnf
51608       consumes:
51609         - application/json
51610         - application/xml
51611       produces:
51612         - application/json
51613         - application/xml
51614       responses:
51615         "default":
51616           description: Response codes found in [response codes](https://wiki.onap.org/).
51617       parameters:
51618         - name: pnf-name
51619           in: path
51620           description: unique name of Physical Network Function.
51621           required: true
51622           type: string
51623           example: __PNF-NAME__
51624         - name: body
51625           in: body
51626           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
51627           required: true
51628           schema:
51629             $ref: "#/definitions/pnf"
51630     patch:
51631       tags:
51632         - Network
51633       summary: update an existing pnf
51634       description: |
51635         Update an existing pnf
51636         #
51637         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51638         The PUT operation will entirely replace an existing object.
51639         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.
51640         #
51641         Other differences between PUT and PATCH are:
51642         #
51643         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51644         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51645         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51646       operationId: UpdateNetworkPnfsPnf
51647       consumes:
51648         - application/json
51649         - application/xml
51650       produces:
51651         - application/json
51652         - application/xml
51653       responses:
51654         "default":
51655           description: Response codes found in [response codes](https://wiki.onap.org/).
51656       parameters:
51657         - name: pnf-name
51658           in: path
51659           description: unique name of Physical Network Function.
51660           required: true
51661           type: string
51662           example: __PNF-NAME__
51663         - name: body
51664           in: body
51665           description: pnf object that needs to be created or updated.
51666           required: true
51667           schema:
51668             $ref: "#/patchDefinitions/pnf"
51669     delete:
51670       tags:
51671         - Network
51672       summary: delete an existing pnf
51673       description: delete an existing pnf
51674       operationId: deleteNetworkPnfsPnf
51675       consumes:
51676         - application/json
51677         - application/xml
51678       produces:
51679         - application/json
51680         - application/xml
51681       responses:
51682         "default":
51683           description: Response codes found in [response codes](https://wiki.onap.org/).
51684       parameters:
51685         - name: pnf-name
51686           in: path
51687           description: unique name of Physical Network Function.
51688           required: true
51689           type: string
51690           example: __PNF-NAME__
51691         - name: resource-version
51692           in: query
51693           description: resource-version for concurrency
51694           required: true
51695           type: string
51696   /network/pnfs:
51697     get:
51698       tags:
51699         - Network
51700       summary: returns pnfs
51701       description: returns pnfs
51702       operationId: getNetworkPnfs
51703       produces:
51704         - application/json
51705         - application/xml
51706       responses:
51707         "200":
51708           description: successful operation
51709           schema:
51710               $ref: "#/getDefinitions/pnfs"
51711         "default":
51712           description: Response codes found in [response codes](https://wiki.onap.org/).
51713   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
51714     put:
51715       tags:
51716         - Network
51717       summary: see node definition for valid relationships
51718       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
51719       consumes:
51720         - application/json
51721         - application/xml
51722       produces:
51723         - application/json
51724         - application/xml
51725       responses:
51726         "default":
51727           description: Response codes found in [response codes](https://wiki.onap.org/).
51728       parameters:
51729         - name: link-name
51730           in: path
51731           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51732           required: true
51733           type: string
51734           example: __LINK-NAME__
51735         - name: body
51736           in: body
51737           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
51738           required: true
51739           schema:
51740             $ref: "#/definitions/relationship"
51741     delete:
51742       tags:
51743         - Network
51744       summary: delete an existing relationship
51745       description: delete an existing relationship
51746       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
51747       consumes:
51748         - application/json
51749         - application/xml
51750       produces:
51751         - application/json
51752         - application/xml
51753       responses:
51754         "default":
51755           description: Response codes found in [response codes](https://wiki.onap.org/).
51756       parameters:
51757         - name: link-name
51758           in: path
51759           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51760           required: true
51761           type: string
51762           example: __LINK-NAME__
51763   /network/physical-links/physical-link/{link-name}:
51764     get:
51765       tags:
51766         - Network
51767       summary: returns physical-link
51768       description: returns physical-link
51769       operationId: getNetworkPhysicalLinksPhysicalLink
51770       produces:
51771         - application/json
51772         - application/xml
51773       responses:
51774         "200":
51775           description: successful operation
51776           schema:
51777               $ref: "#/getDefinitions/physical-link"
51778         "default":
51779           description: Response codes found in [response codes](https://wiki.onap.org/).
51780       parameters:
51781         - name: link-name
51782           in: path
51783           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51784           required: true
51785           type: string
51786           example: __LINK-NAME__
51787         - name: circuit-id
51788           in: query
51789           description: Circuit it
51790           required: false
51791           type: string
51792     put:
51793       tags:
51794         - Network
51795       summary: create or update an existing physical-link
51796       description: |
51797         Create or update an existing physical-link.
51798         #
51799         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
51800       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
51801       consumes:
51802         - application/json
51803         - application/xml
51804       produces:
51805         - application/json
51806         - application/xml
51807       responses:
51808         "default":
51809           description: Response codes found in [response codes](https://wiki.onap.org/).
51810       parameters:
51811         - name: link-name
51812           in: path
51813           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51814           required: true
51815           type: string
51816           example: __LINK-NAME__
51817         - name: body
51818           in: body
51819           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
51820           required: true
51821           schema:
51822             $ref: "#/definitions/physical-link"
51823     patch:
51824       tags:
51825         - Network
51826       summary: update an existing physical-link
51827       description: |
51828         Update an existing physical-link
51829         #
51830         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51831         The PUT operation will entirely replace an existing object.
51832         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.
51833         #
51834         Other differences between PUT and PATCH are:
51835         #
51836         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51837         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51838         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51839       operationId: UpdateNetworkPhysicalLinksPhysicalLink
51840       consumes:
51841         - application/json
51842         - application/xml
51843       produces:
51844         - application/json
51845         - application/xml
51846       responses:
51847         "default":
51848           description: Response codes found in [response codes](https://wiki.onap.org/).
51849       parameters:
51850         - name: link-name
51851           in: path
51852           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51853           required: true
51854           type: string
51855           example: __LINK-NAME__
51856         - name: body
51857           in: body
51858           description: physical-link object that needs to be created or updated.
51859           required: true
51860           schema:
51861             $ref: "#/patchDefinitions/physical-link"
51862     delete:
51863       tags:
51864         - Network
51865       summary: delete an existing physical-link
51866       description: delete an existing physical-link
51867       operationId: deleteNetworkPhysicalLinksPhysicalLink
51868       consumes:
51869         - application/json
51870         - application/xml
51871       produces:
51872         - application/json
51873         - application/xml
51874       responses:
51875         "default":
51876           description: Response codes found in [response codes](https://wiki.onap.org/).
51877       parameters:
51878         - name: link-name
51879           in: path
51880           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51881           required: true
51882           type: string
51883           example: __LINK-NAME__
51884         - name: resource-version
51885           in: query
51886           description: resource-version for concurrency
51887           required: true
51888           type: string
51889   /network/physical-links:
51890     get:
51891       tags:
51892         - Network
51893       summary: returns physical-links
51894       description: returns physical-links
51895       operationId: getNetworkPhysicalLinks
51896       produces:
51897         - application/json
51898         - application/xml
51899       responses:
51900         "200":
51901           description: successful operation
51902           schema:
51903               $ref: "#/getDefinitions/physical-links"
51904         "default":
51905           description: Response codes found in [response codes](https://wiki.onap.org/).
51906   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
51907     put:
51908       tags:
51909         - Network
51910       summary: see node definition for valid relationships
51911       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
51912       consumes:
51913         - application/json
51914         - application/xml
51915       produces:
51916         - application/json
51917         - application/xml
51918       responses:
51919         "default":
51920           description: Response codes found in [response codes](https://wiki.onap.org/).
51921       parameters:
51922         - name: ipsec-configuration-id
51923           in: path
51924           description: UUID of this configuration
51925           required: true
51926           type: string
51927           example: __IPSEC-CONFIGURATION-ID__
51928         - name: body
51929           in: body
51930           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
51931           required: true
51932           schema:
51933             $ref: "#/definitions/relationship"
51934     delete:
51935       tags:
51936         - Network
51937       summary: delete an existing relationship
51938       description: delete an existing relationship
51939       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
51940       consumes:
51941         - application/json
51942         - application/xml
51943       produces:
51944         - application/json
51945         - application/xml
51946       responses:
51947         "default":
51948           description: Response codes found in [response codes](https://wiki.onap.org/).
51949       parameters:
51950         - name: ipsec-configuration-id
51951           in: path
51952           description: UUID of this configuration
51953           required: true
51954           type: string
51955           example: __IPSEC-CONFIGURATION-ID__
51956   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
51957     put:
51958       tags:
51959         - Network
51960       summary: see node definition for valid relationships
51961       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51962       consumes:
51963         - application/json
51964         - application/xml
51965       produces:
51966         - application/json
51967         - application/xml
51968       responses:
51969         "default":
51970           description: Response codes found in [response codes](https://wiki.onap.org/).
51971       parameters:
51972         - name: ipsec-configuration-id
51973           in: path
51974           description: UUID of this configuration
51975           required: true
51976           type: string
51977           example: __IPSEC-CONFIGURATION-ID__
51978         - name: vig-address-type
51979           in: path
51980           description: indicates whether the VIG is for AVPN or INTERNET
51981           required: true
51982           type: string
51983           example: __VIG-ADDRESS-TYPE__
51984         - name: body
51985           in: body
51986           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51987           required: true
51988           schema:
51989             $ref: "#/definitions/relationship"
51990     delete:
51991       tags:
51992         - Network
51993       summary: delete an existing relationship
51994       description: delete an existing relationship
51995       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51996       consumes:
51997         - application/json
51998         - application/xml
51999       produces:
52000         - application/json
52001         - application/xml
52002       responses:
52003         "default":
52004           description: Response codes found in [response codes](https://wiki.onap.org/).
52005       parameters:
52006         - name: ipsec-configuration-id
52007           in: path
52008           description: UUID of this configuration
52009           required: true
52010           type: string
52011           example: __IPSEC-CONFIGURATION-ID__
52012         - name: vig-address-type
52013           in: path
52014           description: indicates whether the VIG is for AVPN or INTERNET
52015           required: true
52016           type: string
52017           example: __VIG-ADDRESS-TYPE__
52018   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
52019     get:
52020       tags:
52021         - Network
52022       summary: returns vig-server
52023       description: returns vig-server
52024       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52025       produces:
52026         - application/json
52027         - application/xml
52028       responses:
52029         "200":
52030           description: successful operation
52031           schema:
52032               $ref: "#/getDefinitions/vig-server"
52033         "default":
52034           description: Response codes found in [response codes](https://wiki.onap.org/).
52035       parameters:
52036         - name: ipsec-configuration-id
52037           in: path
52038           description: UUID of this configuration
52039           required: true
52040           type: string
52041           example: __IPSEC-CONFIGURATION-ID__
52042         - name: vig-address-type
52043           in: path
52044           description: indicates whether the VIG is for AVPN or INTERNET
52045           required: true
52046           type: string
52047           example: __VIG-ADDRESS-TYPE__
52048     put:
52049       tags:
52050         - Network
52051       summary: create or update an existing vig-server
52052       description: |
52053         Create or update an existing vig-server.
52054         #
52055         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
52056       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52057       consumes:
52058         - application/json
52059         - application/xml
52060       produces:
52061         - application/json
52062         - application/xml
52063       responses:
52064         "default":
52065           description: Response codes found in [response codes](https://wiki.onap.org/).
52066       parameters:
52067         - name: ipsec-configuration-id
52068           in: path
52069           description: UUID of this configuration
52070           required: true
52071           type: string
52072           example: __IPSEC-CONFIGURATION-ID__
52073         - name: vig-address-type
52074           in: path
52075           description: indicates whether the VIG is for AVPN or INTERNET
52076           required: true
52077           type: string
52078           example: __VIG-ADDRESS-TYPE__
52079         - name: body
52080           in: body
52081           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
52082           required: true
52083           schema:
52084             $ref: "#/definitions/vig-server"
52085     patch:
52086       tags:
52087         - Network
52088       summary: update an existing vig-server
52089       description: |
52090         Update an existing vig-server
52091         #
52092         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52093         The PUT operation will entirely replace an existing object.
52094         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.
52095         #
52096         Other differences between PUT and PATCH are:
52097         #
52098         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52099         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52100         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52101       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52102       consumes:
52103         - application/json
52104         - application/xml
52105       produces:
52106         - application/json
52107         - application/xml
52108       responses:
52109         "default":
52110           description: Response codes found in [response codes](https://wiki.onap.org/).
52111       parameters:
52112         - name: ipsec-configuration-id
52113           in: path
52114           description: UUID of this configuration
52115           required: true
52116           type: string
52117           example: __IPSEC-CONFIGURATION-ID__
52118         - name: vig-address-type
52119           in: path
52120           description: indicates whether the VIG is for AVPN or INTERNET
52121           required: true
52122           type: string
52123           example: __VIG-ADDRESS-TYPE__
52124         - name: body
52125           in: body
52126           description: vig-server object that needs to be created or updated.
52127           required: true
52128           schema:
52129             $ref: "#/patchDefinitions/vig-server"
52130     delete:
52131       tags:
52132         - Network
52133       summary: delete an existing vig-server
52134       description: delete an existing vig-server
52135       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
52136       consumes:
52137         - application/json
52138         - application/xml
52139       produces:
52140         - application/json
52141         - application/xml
52142       responses:
52143         "default":
52144           description: Response codes found in [response codes](https://wiki.onap.org/).
52145       parameters:
52146         - name: ipsec-configuration-id
52147           in: path
52148           description: UUID of this configuration
52149           required: true
52150           type: string
52151           example: __IPSEC-CONFIGURATION-ID__
52152         - name: vig-address-type
52153           in: path
52154           description: indicates whether the VIG is for AVPN or INTERNET
52155           required: true
52156           type: string
52157           example: __VIG-ADDRESS-TYPE__
52158         - name: resource-version
52159           in: query
52160           description: resource-version for concurrency
52161           required: true
52162           type: string
52163   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
52164     get:
52165       tags:
52166         - Network
52167       summary: returns vig-servers
52168       description: returns vig-servers
52169       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
52170       produces:
52171         - application/json
52172         - application/xml
52173       responses:
52174         "200":
52175           description: successful operation
52176           schema:
52177               $ref: "#/getDefinitions/vig-servers"
52178         "default":
52179           description: Response codes found in [response codes](https://wiki.onap.org/).
52180       parameters:
52181         - name: ipsec-configuration-id
52182           in: path
52183           description: UUID of this configuration
52184           required: true
52185           type: string
52186           example: __IPSEC-CONFIGURATION-ID__
52187   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
52188     get:
52189       tags:
52190         - Network
52191       summary: returns ipsec-configuration
52192       description: returns ipsec-configuration
52193       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
52194       produces:
52195         - application/json
52196         - application/xml
52197       responses:
52198         "200":
52199           description: successful operation
52200           schema:
52201               $ref: "#/getDefinitions/ipsec-configuration"
52202         "default":
52203           description: Response codes found in [response codes](https://wiki.onap.org/).
52204       parameters:
52205         - name: ipsec-configuration-id
52206           in: path
52207           description: UUID of this configuration
52208           required: true
52209           type: string
52210           example: __IPSEC-CONFIGURATION-ID__
52211     put:
52212       tags:
52213         - Network
52214       summary: create or update an existing ipsec-configuration
52215       description: |
52216         Create or update an existing ipsec-configuration.
52217         #
52218         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
52219       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
52220       consumes:
52221         - application/json
52222         - application/xml
52223       produces:
52224         - application/json
52225         - application/xml
52226       responses:
52227         "default":
52228           description: Response codes found in [response codes](https://wiki.onap.org/).
52229       parameters:
52230         - name: ipsec-configuration-id
52231           in: path
52232           description: UUID of this configuration
52233           required: true
52234           type: string
52235           example: __IPSEC-CONFIGURATION-ID__
52236         - name: body
52237           in: body
52238           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
52239           required: true
52240           schema:
52241             $ref: "#/definitions/ipsec-configuration"
52242     patch:
52243       tags:
52244         - Network
52245       summary: update an existing ipsec-configuration
52246       description: |
52247         Update an existing ipsec-configuration
52248         #
52249         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52250         The PUT operation will entirely replace an existing object.
52251         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.
52252         #
52253         Other differences between PUT and PATCH are:
52254         #
52255         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52256         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52257         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52258       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
52259       consumes:
52260         - application/json
52261         - application/xml
52262       produces:
52263         - application/json
52264         - application/xml
52265       responses:
52266         "default":
52267           description: Response codes found in [response codes](https://wiki.onap.org/).
52268       parameters:
52269         - name: ipsec-configuration-id
52270           in: path
52271           description: UUID of this configuration
52272           required: true
52273           type: string
52274           example: __IPSEC-CONFIGURATION-ID__
52275         - name: body
52276           in: body
52277           description: ipsec-configuration object that needs to be created or updated.
52278           required: true
52279           schema:
52280             $ref: "#/patchDefinitions/ipsec-configuration"
52281     delete:
52282       tags:
52283         - Network
52284       summary: delete an existing ipsec-configuration
52285       description: delete an existing ipsec-configuration
52286       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
52287       consumes:
52288         - application/json
52289         - application/xml
52290       produces:
52291         - application/json
52292         - application/xml
52293       responses:
52294         "default":
52295           description: Response codes found in [response codes](https://wiki.onap.org/).
52296       parameters:
52297         - name: ipsec-configuration-id
52298           in: path
52299           description: UUID of this configuration
52300           required: true
52301           type: string
52302           example: __IPSEC-CONFIGURATION-ID__
52303         - name: resource-version
52304           in: query
52305           description: resource-version for concurrency
52306           required: true
52307           type: string
52308   /network/ipsec-configurations:
52309     get:
52310       tags:
52311         - Network
52312       summary: returns ipsec-configurations
52313       description: returns ipsec-configurations
52314       operationId: getNetworkIpsecConfigurations
52315       produces:
52316         - application/json
52317         - application/xml
52318       responses:
52319         "200":
52320           description: successful operation
52321           schema:
52322               $ref: "#/getDefinitions/ipsec-configurations"
52323         "default":
52324           description: Response codes found in [response codes](https://wiki.onap.org/).
52325   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
52326     put:
52327       tags:
52328         - Network
52329       summary: see node definition for valid relationships
52330       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
52331       consumes:
52332         - application/json
52333         - application/xml
52334       produces:
52335         - application/json
52336         - application/xml
52337       responses:
52338         "default":
52339           description: Response codes found in [response codes](https://wiki.onap.org/).
52340       parameters:
52341         - name: route-table-reference-id
52342           in: path
52343           description: Route Table Reference id, UUID assigned to this instance.
52344           required: true
52345           type: string
52346           example: __ROUTE-TABLE-REFERENCE-ID__
52347         - name: body
52348           in: body
52349           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
52350           required: true
52351           schema:
52352             $ref: "#/definitions/relationship"
52353     delete:
52354       tags:
52355         - Network
52356       summary: delete an existing relationship
52357       description: delete an existing relationship
52358       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
52359       consumes:
52360         - application/json
52361         - application/xml
52362       produces:
52363         - application/json
52364         - application/xml
52365       responses:
52366         "default":
52367           description: Response codes found in [response codes](https://wiki.onap.org/).
52368       parameters:
52369         - name: route-table-reference-id
52370           in: path
52371           description: Route Table Reference id, UUID assigned to this instance.
52372           required: true
52373           type: string
52374           example: __ROUTE-TABLE-REFERENCE-ID__
52375   /network/route-table-references/route-table-reference/{route-table-reference-id}:
52376     get:
52377       tags:
52378         - Network
52379       summary: returns route-table-reference
52380       description: returns route-table-reference
52381       operationId: getNetworkRouteTableReferencesRouteTableReference
52382       produces:
52383         - application/json
52384         - application/xml
52385       responses:
52386         "200":
52387           description: successful operation
52388           schema:
52389               $ref: "#/getDefinitions/route-table-reference"
52390         "default":
52391           description: Response codes found in [response codes](https://wiki.onap.org/).
52392       parameters:
52393         - name: route-table-reference-id
52394           in: path
52395           description: Route Table Reference id, UUID assigned to this instance.
52396           required: true
52397           type: string
52398           example: __ROUTE-TABLE-REFERENCE-ID__
52399         - name: route-table-reference-fqdn
52400           in: query
52401           description: FQDN entry in the route table.
52402           required: false
52403           type: string
52404     put:
52405       tags:
52406         - Network
52407       summary: create or update an existing route-table-reference
52408       description: |
52409         Create or update an existing route-table-reference.
52410         #
52411         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
52412       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
52413       consumes:
52414         - application/json
52415         - application/xml
52416       produces:
52417         - application/json
52418         - application/xml
52419       responses:
52420         "default":
52421           description: Response codes found in [response codes](https://wiki.onap.org/).
52422       parameters:
52423         - name: route-table-reference-id
52424           in: path
52425           description: Route Table Reference id, UUID assigned to this instance.
52426           required: true
52427           type: string
52428           example: __ROUTE-TABLE-REFERENCE-ID__
52429         - name: body
52430           in: body
52431           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
52432           required: true
52433           schema:
52434             $ref: "#/definitions/route-table-reference"
52435     patch:
52436       tags:
52437         - Network
52438       summary: update an existing route-table-reference
52439       description: |
52440         Update an existing route-table-reference
52441         #
52442         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52443         The PUT operation will entirely replace an existing object.
52444         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.
52445         #
52446         Other differences between PUT and PATCH are:
52447         #
52448         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52449         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52450         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52451       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
52452       consumes:
52453         - application/json
52454         - application/xml
52455       produces:
52456         - application/json
52457         - application/xml
52458       responses:
52459         "default":
52460           description: Response codes found in [response codes](https://wiki.onap.org/).
52461       parameters:
52462         - name: route-table-reference-id
52463           in: path
52464           description: Route Table Reference id, UUID assigned to this instance.
52465           required: true
52466           type: string
52467           example: __ROUTE-TABLE-REFERENCE-ID__
52468         - name: body
52469           in: body
52470           description: route-table-reference object that needs to be created or updated.
52471           required: true
52472           schema:
52473             $ref: "#/patchDefinitions/route-table-reference"
52474     delete:
52475       tags:
52476         - Network
52477       summary: delete an existing route-table-reference
52478       description: delete an existing route-table-reference
52479       operationId: deleteNetworkRouteTableReferencesRouteTableReference
52480       consumes:
52481         - application/json
52482         - application/xml
52483       produces:
52484         - application/json
52485         - application/xml
52486       responses:
52487         "default":
52488           description: Response codes found in [response codes](https://wiki.onap.org/).
52489       parameters:
52490         - name: route-table-reference-id
52491           in: path
52492           description: Route Table Reference id, UUID assigned to this instance.
52493           required: true
52494           type: string
52495           example: __ROUTE-TABLE-REFERENCE-ID__
52496         - name: resource-version
52497           in: query
52498           description: resource-version for concurrency
52499           required: true
52500           type: string
52501   /network/route-table-references:
52502     get:
52503       tags:
52504         - Network
52505       summary: returns route-table-references
52506       description: returns route-table-references
52507       operationId: getNetworkRouteTableReferences
52508       produces:
52509         - application/json
52510         - application/xml
52511       responses:
52512         "200":
52513           description: successful operation
52514           schema:
52515               $ref: "#/getDefinitions/route-table-references"
52516         "default":
52517           description: Response codes found in [response codes](https://wiki.onap.org/).
52518   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
52519     put:
52520       tags:
52521         - Network
52522       summary: see node definition for valid relationships
52523       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
52524       consumes:
52525         - application/json
52526         - application/xml
52527       produces:
52528         - application/json
52529         - application/xml
52530       responses:
52531         "default":
52532           description: Response codes found in [response codes](https://wiki.onap.org/).
52533       parameters:
52534         - name: id
52535           in: path
52536           description: Instance Group ID, UUID assigned to this instance.
52537           required: true
52538           type: string
52539           example: __ID__
52540         - name: body
52541           in: body
52542           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
52543           required: true
52544           schema:
52545             $ref: "#/definitions/relationship"
52546     delete:
52547       tags:
52548         - Network
52549       summary: delete an existing relationship
52550       description: delete an existing relationship
52551       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
52552       consumes:
52553         - application/json
52554         - application/xml
52555       produces:
52556         - application/json
52557         - application/xml
52558       responses:
52559         "default":
52560           description: Response codes found in [response codes](https://wiki.onap.org/).
52561       parameters:
52562         - name: id
52563           in: path
52564           description: Instance Group ID, UUID assigned to this instance.
52565           required: true
52566           type: string
52567           example: __ID__
52568   /network/instance-groups/instance-group/{id}:
52569     get:
52570       tags:
52571         - Network
52572       summary: returns instance-group
52573       description: returns instance-group
52574       operationId: getNetworkInstanceGroupsInstanceGroup
52575       produces:
52576         - application/json
52577         - application/xml
52578       responses:
52579         "200":
52580           description: successful operation
52581           schema:
52582               $ref: "#/getDefinitions/instance-group"
52583         "default":
52584           description: Response codes found in [response codes](https://wiki.onap.org/).
52585       parameters:
52586         - name: id
52587           in: path
52588           description: Instance Group ID, UUID assigned to this instance.
52589           required: true
52590           type: string
52591           example: __ID__
52592         - name: description
52593           in: query
52594           description: Descriptive text to help identify the usage of this instance-group
52595           required: false
52596           type: string
52597         - name: type
52598           in: query
52599           description: Only valid value today is lower case ha for high availability
52600           required: false
52601           type: string
52602         - name: sub-type
52603           in: query
52604           description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
52605           required: false
52606           type: string
52607     put:
52608       tags:
52609         - Network
52610       summary: create or update an existing instance-group
52611       description: |
52612         Create or update an existing instance-group.
52613         #
52614         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
52615       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
52616       consumes:
52617         - application/json
52618         - application/xml
52619       produces:
52620         - application/json
52621         - application/xml
52622       responses:
52623         "default":
52624           description: Response codes found in [response codes](https://wiki.onap.org/).
52625       parameters:
52626         - name: id
52627           in: path
52628           description: Instance Group ID, UUID assigned to this instance.
52629           required: true
52630           type: string
52631           example: __ID__
52632         - name: body
52633           in: body
52634           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
52635           required: true
52636           schema:
52637             $ref: "#/definitions/instance-group"
52638     patch:
52639       tags:
52640         - Network
52641       summary: update an existing instance-group
52642       description: |
52643         Update an existing instance-group
52644         #
52645         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52646         The PUT operation will entirely replace an existing object.
52647         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.
52648         #
52649         Other differences between PUT and PATCH are:
52650         #
52651         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52652         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52653         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52654       operationId: UpdateNetworkInstanceGroupsInstanceGroup
52655       consumes:
52656         - application/json
52657         - application/xml
52658       produces:
52659         - application/json
52660         - application/xml
52661       responses:
52662         "default":
52663           description: Response codes found in [response codes](https://wiki.onap.org/).
52664       parameters:
52665         - name: id
52666           in: path
52667           description: Instance Group ID, UUID assigned to this instance.
52668           required: true
52669           type: string
52670           example: __ID__
52671         - name: body
52672           in: body
52673           description: instance-group object that needs to be created or updated.
52674           required: true
52675           schema:
52676             $ref: "#/patchDefinitions/instance-group"
52677     delete:
52678       tags:
52679         - Network
52680       summary: delete an existing instance-group
52681       description: delete an existing instance-group
52682       operationId: deleteNetworkInstanceGroupsInstanceGroup
52683       consumes:
52684         - application/json
52685         - application/xml
52686       produces:
52687         - application/json
52688         - application/xml
52689       responses:
52690         "default":
52691           description: Response codes found in [response codes](https://wiki.onap.org/).
52692       parameters:
52693         - name: id
52694           in: path
52695           description: Instance Group ID, UUID assigned to this instance.
52696           required: true
52697           type: string
52698           example: __ID__
52699         - name: resource-version
52700           in: query
52701           description: resource-version for concurrency
52702           required: true
52703           type: string
52704   /network/instance-groups:
52705     get:
52706       tags:
52707         - Network
52708       summary: returns instance-groups
52709       description: returns instance-groups
52710       operationId: getNetworkInstanceGroups
52711       produces:
52712         - application/json
52713         - application/xml
52714       responses:
52715         "200":
52716           description: successful operation
52717           schema:
52718               $ref: "#/getDefinitions/instance-groups"
52719         "default":
52720           description: Response codes found in [response codes](https://wiki.onap.org/).
52721   /network/zones/zone/{zone-id}/relationship-list/relationship:
52722     put:
52723       tags:
52724         - Network
52725       summary: see node definition for valid relationships
52726       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
52727       consumes:
52728         - application/json
52729         - application/xml
52730       produces:
52731         - application/json
52732         - application/xml
52733       responses:
52734         "default":
52735           description: Response codes found in [response codes](https://wiki.onap.org/).
52736       parameters:
52737         - name: zone-id
52738           in: path
52739           description: Code assigned by AIC to the zone
52740           required: true
52741           type: string
52742           example: __ZONE-ID__
52743         - name: body
52744           in: body
52745           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
52746           required: true
52747           schema:
52748             $ref: "#/definitions/relationship"
52749     delete:
52750       tags:
52751         - Network
52752       summary: delete an existing relationship
52753       description: delete an existing relationship
52754       operationId: deleteNetworkZonesZoneRelationshipListRelationship
52755       consumes:
52756         - application/json
52757         - application/xml
52758       produces:
52759         - application/json
52760         - application/xml
52761       responses:
52762         "default":
52763           description: Response codes found in [response codes](https://wiki.onap.org/).
52764       parameters:
52765         - name: zone-id
52766           in: path
52767           description: Code assigned by AIC to the zone
52768           required: true
52769           type: string
52770           example: __ZONE-ID__
52771   /network/zones/zone/{zone-id}:
52772     get:
52773       tags:
52774         - Network
52775       summary: returns zone
52776       description: returns zone
52777       operationId: getNetworkZonesZone
52778       produces:
52779         - application/json
52780         - application/xml
52781       responses:
52782         "200":
52783           description: successful operation
52784           schema:
52785               $ref: "#/getDefinitions/zone"
52786         "default":
52787           description: Response codes found in [response codes](https://wiki.onap.org/).
52788       parameters:
52789         - name: zone-id
52790           in: path
52791           description: Code assigned by AIC to the zone
52792           required: true
52793           type: string
52794           example: __ZONE-ID__
52795         - name: design-type
52796           in: query
52797           description: Design of zone [Medium/Large…]
52798           required: false
52799           type: string
52800         - name: zone-context
52801           in: query
52802           description: Context of zone [production/test]
52803           required: false
52804           type: string
52805     put:
52806       tags:
52807         - Network
52808       summary: create or update an existing zone
52809       description: |
52810         Create or update an existing zone.
52811         #
52812         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
52813       operationId: createOrUpdateNetworkZonesZone
52814       consumes:
52815         - application/json
52816         - application/xml
52817       produces:
52818         - application/json
52819         - application/xml
52820       responses:
52821         "default":
52822           description: Response codes found in [response codes](https://wiki.onap.org/).
52823       parameters:
52824         - name: zone-id
52825           in: path
52826           description: Code assigned by AIC to the zone
52827           required: true
52828           type: string
52829           example: __ZONE-ID__
52830         - name: body
52831           in: body
52832           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
52833           required: true
52834           schema:
52835             $ref: "#/definitions/zone"
52836     patch:
52837       tags:
52838         - Network
52839       summary: update an existing zone
52840       description: |
52841         Update an existing zone
52842         #
52843         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52844         The PUT operation will entirely replace an existing object.
52845         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.
52846         #
52847         Other differences between PUT and PATCH are:
52848         #
52849         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52850         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52851         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52852       operationId: UpdateNetworkZonesZone
52853       consumes:
52854         - application/json
52855         - application/xml
52856       produces:
52857         - application/json
52858         - application/xml
52859       responses:
52860         "default":
52861           description: Response codes found in [response codes](https://wiki.onap.org/).
52862       parameters:
52863         - name: zone-id
52864           in: path
52865           description: Code assigned by AIC to the zone
52866           required: true
52867           type: string
52868           example: __ZONE-ID__
52869         - name: body
52870           in: body
52871           description: zone object that needs to be created or updated.
52872           required: true
52873           schema:
52874             $ref: "#/patchDefinitions/zone"
52875     delete:
52876       tags:
52877         - Network
52878       summary: delete an existing zone
52879       description: delete an existing zone
52880       operationId: deleteNetworkZonesZone
52881       consumes:
52882         - application/json
52883         - application/xml
52884       produces:
52885         - application/json
52886         - application/xml
52887       responses:
52888         "default":
52889           description: Response codes found in [response codes](https://wiki.onap.org/).
52890       parameters:
52891         - name: zone-id
52892           in: path
52893           description: Code assigned by AIC to the zone
52894           required: true
52895           type: string
52896           example: __ZONE-ID__
52897         - name: resource-version
52898           in: query
52899           description: resource-version for concurrency
52900           required: true
52901           type: string
52902   /network/zones:
52903     get:
52904       tags:
52905         - Network
52906       summary: returns zones
52907       description: returns zones
52908       operationId: getNetworkZones
52909       produces:
52910         - application/json
52911         - application/xml
52912       responses:
52913         "200":
52914           description: successful operation
52915           schema:
52916               $ref: "#/getDefinitions/zones"
52917         "default":
52918           description: Response codes found in [response codes](https://wiki.onap.org/).
52919   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
52920     put:
52921       tags:
52922         - Network
52923       summary: see node definition for valid relationships
52924       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
52925       consumes:
52926         - application/json
52927         - application/xml
52928       produces:
52929         - application/json
52930         - application/xml
52931       responses:
52932         "default":
52933           description: Response codes found in [response codes](https://wiki.onap.org/).
52934       parameters:
52935         - name: configuration-id
52936           in: path
52937           description: UUID assigned to configuration.
52938           required: true
52939           type: string
52940           example: __CONFIGURATION-ID__
52941         - name: body
52942           in: body
52943           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
52944           required: true
52945           schema:
52946             $ref: "#/definitions/relationship"
52947     delete:
52948       tags:
52949         - Network
52950       summary: delete an existing relationship
52951       description: delete an existing relationship
52952       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
52953       consumes:
52954         - application/json
52955         - application/xml
52956       produces:
52957         - application/json
52958         - application/xml
52959       responses:
52960         "default":
52961           description: Response codes found in [response codes](https://wiki.onap.org/).
52962       parameters:
52963         - name: configuration-id
52964           in: path
52965           description: UUID assigned to configuration.
52966           required: true
52967           type: string
52968           example: __CONFIGURATION-ID__
52969   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
52970     get:
52971       tags:
52972         - Network
52973       summary: returns metadatum
52974       description: returns metadatum
52975       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
52976       produces:
52977         - application/json
52978         - application/xml
52979       responses:
52980         "200":
52981           description: successful operation
52982           schema:
52983               $ref: "#/getDefinitions/metadatum"
52984         "default":
52985           description: Response codes found in [response codes](https://wiki.onap.org/).
52986       parameters:
52987         - name: configuration-id
52988           in: path
52989           description: UUID assigned to configuration.
52990           required: true
52991           type: string
52992           example: __CONFIGURATION-ID__
52993         - name: metaname
52994           in: path
52995           required: true
52996           type: string
52997           example: __METANAME__
52998         - name: model-invariant-id
52999           in: query
53000           description: the ASDC model id for this resource or service model.
53001           required: false
53002           type: string
53003         - name: model-version-id
53004           in: query
53005           description: the ASDC model version for this resource or service model.
53006           required: false
53007           type: string
53008     put:
53009       tags:
53010         - Network
53011       summary: create or update an existing metadatum
53012       description: |
53013         Create or update an existing metadatum.
53014         #
53015         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
53016       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
53017       consumes:
53018         - application/json
53019         - application/xml
53020       produces:
53021         - application/json
53022         - application/xml
53023       responses:
53024         "default":
53025           description: Response codes found in [response codes](https://wiki.onap.org/).
53026       parameters:
53027         - name: configuration-id
53028           in: path
53029           description: UUID assigned to configuration.
53030           required: true
53031           type: string
53032           example: __CONFIGURATION-ID__
53033         - name: metaname
53034           in: path
53035           required: true
53036           type: string
53037           example: __METANAME__
53038         - name: body
53039           in: body
53040           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)
53041           required: true
53042           schema:
53043             $ref: "#/definitions/metadatum"
53044     patch:
53045       tags:
53046         - Network
53047       summary: update an existing metadatum
53048       description: |
53049         Update an existing metadatum
53050         #
53051         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53052         The PUT operation will entirely replace an existing object.
53053         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.
53054         #
53055         Other differences between PUT and PATCH are:
53056         #
53057         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53058         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53059         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53060       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
53061       consumes:
53062         - application/json
53063         - application/xml
53064       produces:
53065         - application/json
53066         - application/xml
53067       responses:
53068         "default":
53069           description: Response codes found in [response codes](https://wiki.onap.org/).
53070       parameters:
53071         - name: configuration-id
53072           in: path
53073           description: UUID assigned to configuration.
53074           required: true
53075           type: string
53076           example: __CONFIGURATION-ID__
53077         - name: metaname
53078           in: path
53079           required: true
53080           type: string
53081           example: __METANAME__
53082         - name: body
53083           in: body
53084           description: metadatum object that needs to be created or updated.
53085           required: true
53086           schema:
53087             $ref: "#/patchDefinitions/metadatum"
53088     delete:
53089       tags:
53090         - Network
53091       summary: delete an existing metadatum
53092       description: delete an existing metadatum
53093       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
53094       consumes:
53095         - application/json
53096         - application/xml
53097       produces:
53098         - application/json
53099         - application/xml
53100       responses:
53101         "default":
53102           description: Response codes found in [response codes](https://wiki.onap.org/).
53103       parameters:
53104         - name: configuration-id
53105           in: path
53106           description: UUID assigned to configuration.
53107           required: true
53108           type: string
53109           example: __CONFIGURATION-ID__
53110         - name: metaname
53111           in: path
53112           required: true
53113           type: string
53114           example: __METANAME__
53115         - name: resource-version
53116           in: query
53117           description: resource-version for concurrency
53118           required: true
53119           type: string
53120   /network/configurations/configuration/{configuration-id}/metadata:
53121     get:
53122       tags:
53123         - Network
53124       summary: returns metadata
53125       description: returns metadata
53126       operationId: getNetworkConfigurationsConfigurationMetadata
53127       produces:
53128         - application/json
53129         - application/xml
53130       responses:
53131         "200":
53132           description: successful operation
53133           schema:
53134               $ref: "#/getDefinitions/metadata"
53135         "default":
53136           description: Response codes found in [response codes](https://wiki.onap.org/).
53137       parameters:
53138         - name: configuration-id
53139           in: path
53140           description: UUID assigned to configuration.
53141           required: true
53142           type: string
53143           example: __CONFIGURATION-ID__
53144         - name: model-invariant-id
53145           in: query
53146           description: the ASDC model id for this resource or service model.
53147           required: false
53148           type: string
53149         - name: model-version-id
53150           in: query
53151           description: the ASDC model version for this resource or service model.
53152           required: false
53153           type: string
53154   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
53155     put:
53156       tags:
53157         - Network
53158       summary: see node definition for valid relationships
53159       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
53160       consumes:
53161         - application/json
53162         - application/xml
53163       produces:
53164         - application/json
53165         - application/xml
53166       responses:
53167         "default":
53168           description: Response codes found in [response codes](https://wiki.onap.org/).
53169       parameters:
53170         - name: configuration-id
53171           in: path
53172           description: UUID assigned to configuration.
53173           required: true
53174           type: string
53175           example: __CONFIGURATION-ID__
53176         - name: forwarder-evc-id
53177           in: path
53178           description: Key for forwarder-evc object
53179           required: true
53180           type: string
53181           example: __FORWARDER-EVC-ID__
53182         - name: body
53183           in: body
53184           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
53185           required: true
53186           schema:
53187             $ref: "#/definitions/relationship"
53188     delete:
53189       tags:
53190         - Network
53191       summary: delete an existing relationship
53192       description: delete an existing relationship
53193       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
53194       consumes:
53195         - application/json
53196         - application/xml
53197       produces:
53198         - application/json
53199         - application/xml
53200       responses:
53201         "default":
53202           description: Response codes found in [response codes](https://wiki.onap.org/).
53203       parameters:
53204         - name: configuration-id
53205           in: path
53206           description: UUID assigned to configuration.
53207           required: true
53208           type: string
53209           example: __CONFIGURATION-ID__
53210         - name: forwarder-evc-id
53211           in: path
53212           description: Key for forwarder-evc object
53213           required: true
53214           type: string
53215           example: __FORWARDER-EVC-ID__
53216   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
53217     get:
53218       tags:
53219         - Network
53220       summary: returns forwarder-evc
53221       description: returns forwarder-evc
53222       operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53223       produces:
53224         - application/json
53225         - application/xml
53226       responses:
53227         "200":
53228           description: successful operation
53229           schema:
53230               $ref: "#/getDefinitions/forwarder-evc"
53231         "default":
53232           description: Response codes found in [response codes](https://wiki.onap.org/).
53233       parameters:
53234         - name: configuration-id
53235           in: path
53236           description: UUID assigned to configuration.
53237           required: true
53238           type: string
53239           example: __CONFIGURATION-ID__
53240         - name: forwarder-evc-id
53241           in: path
53242           description: Key for forwarder-evc object
53243           required: true
53244           type: string
53245           example: __FORWARDER-EVC-ID__
53246         - name: model-invariant-id
53247           in: query
53248           description: the ASDC model id for this resource or service model.
53249           required: false
53250           type: string
53251         - name: model-version-id
53252           in: query
53253           description: the ASDC model version for this resource or service model.
53254           required: false
53255           type: string
53256     put:
53257       tags:
53258         - Network
53259       summary: create or update an existing forwarder-evc
53260       description: |
53261         Create or update an existing forwarder-evc.
53262         #
53263         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
53264       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53265       consumes:
53266         - application/json
53267         - application/xml
53268       produces:
53269         - application/json
53270         - application/xml
53271       responses:
53272         "default":
53273           description: Response codes found in [response codes](https://wiki.onap.org/).
53274       parameters:
53275         - name: configuration-id
53276           in: path
53277           description: UUID assigned to configuration.
53278           required: true
53279           type: string
53280           example: __CONFIGURATION-ID__
53281         - name: forwarder-evc-id
53282           in: path
53283           description: Key for forwarder-evc object
53284           required: true
53285           type: string
53286           example: __FORWARDER-EVC-ID__
53287         - name: body
53288           in: body
53289           description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
53290           required: true
53291           schema:
53292             $ref: "#/definitions/forwarder-evc"
53293     patch:
53294       tags:
53295         - Network
53296       summary: update an existing forwarder-evc
53297       description: |
53298         Update an existing forwarder-evc
53299         #
53300         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53301         The PUT operation will entirely replace an existing object.
53302         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.
53303         #
53304         Other differences between PUT and PATCH are:
53305         #
53306         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53307         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53308         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53309       operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53310       consumes:
53311         - application/json
53312         - application/xml
53313       produces:
53314         - application/json
53315         - application/xml
53316       responses:
53317         "default":
53318           description: Response codes found in [response codes](https://wiki.onap.org/).
53319       parameters:
53320         - name: configuration-id
53321           in: path
53322           description: UUID assigned to configuration.
53323           required: true
53324           type: string
53325           example: __CONFIGURATION-ID__
53326         - name: forwarder-evc-id
53327           in: path
53328           description: Key for forwarder-evc object
53329           required: true
53330           type: string
53331           example: __FORWARDER-EVC-ID__
53332         - name: body
53333           in: body
53334           description: forwarder-evc object that needs to be created or updated.
53335           required: true
53336           schema:
53337             $ref: "#/patchDefinitions/forwarder-evc"
53338     delete:
53339       tags:
53340         - Network
53341       summary: delete an existing forwarder-evc
53342       description: delete an existing forwarder-evc
53343       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
53344       consumes:
53345         - application/json
53346         - application/xml
53347       produces:
53348         - application/json
53349         - application/xml
53350       responses:
53351         "default":
53352           description: Response codes found in [response codes](https://wiki.onap.org/).
53353       parameters:
53354         - name: configuration-id
53355           in: path
53356           description: UUID assigned to configuration.
53357           required: true
53358           type: string
53359           example: __CONFIGURATION-ID__
53360         - name: forwarder-evc-id
53361           in: path
53362           description: Key for forwarder-evc object
53363           required: true
53364           type: string
53365           example: __FORWARDER-EVC-ID__
53366         - name: resource-version
53367           in: query
53368           description: resource-version for concurrency
53369           required: true
53370           type: string
53371   /network/configurations/configuration/{configuration-id}/forwarder-evcs:
53372     get:
53373       tags:
53374         - Network
53375       summary: returns forwarder-evcs
53376       description: returns forwarder-evcs
53377       operationId: getNetworkConfigurationsConfigurationForwarderEvcs
53378       produces:
53379         - application/json
53380         - application/xml
53381       responses:
53382         "200":
53383           description: successful operation
53384           schema:
53385               $ref: "#/getDefinitions/forwarder-evcs"
53386         "default":
53387           description: Response codes found in [response codes](https://wiki.onap.org/).
53388       parameters:
53389         - name: configuration-id
53390           in: path
53391           description: UUID assigned to configuration.
53392           required: true
53393           type: string
53394           example: __CONFIGURATION-ID__
53395         - name: model-invariant-id
53396           in: query
53397           description: the ASDC model id for this resource or service model.
53398           required: false
53399           type: string
53400         - name: model-version-id
53401           in: query
53402           description: the ASDC model version for this resource or service model.
53403           required: false
53404           type: string
53405   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
53406     put:
53407       tags:
53408         - Network
53409       summary: see node definition for valid relationships
53410       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
53411       consumes:
53412         - application/json
53413         - application/xml
53414       produces:
53415         - application/json
53416         - application/xml
53417       responses:
53418         "default":
53419           description: Response codes found in [response codes](https://wiki.onap.org/).
53420       parameters:
53421         - name: configuration-id
53422           in: path
53423           description: UUID assigned to configuration.
53424           required: true
53425           type: string
53426           example: __CONFIGURATION-ID__
53427         - name: evc-id
53428           in: path
53429           description: Unique/key field for the evc object
53430           required: true
53431           type: string
53432           example: __EVC-ID__
53433         - name: body
53434           in: body
53435           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
53436           required: true
53437           schema:
53438             $ref: "#/definitions/relationship"
53439     delete:
53440       tags:
53441         - Network
53442       summary: delete an existing relationship
53443       description: delete an existing relationship
53444       operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
53445       consumes:
53446         - application/json
53447         - application/xml
53448       produces:
53449         - application/json
53450         - application/xml
53451       responses:
53452         "default":
53453           description: Response codes found in [response codes](https://wiki.onap.org/).
53454       parameters:
53455         - name: configuration-id
53456           in: path
53457           description: UUID assigned to configuration.
53458           required: true
53459           type: string
53460           example: __CONFIGURATION-ID__
53461         - name: evc-id
53462           in: path
53463           description: Unique/key field for the evc object
53464           required: true
53465           type: string
53466           example: __EVC-ID__
53467   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
53468     get:
53469       tags:
53470         - Network
53471       summary: returns evc
53472       description: returns evc
53473       operationId: getNetworkConfigurationsConfigurationEvcsEvc
53474       produces:
53475         - application/json
53476         - application/xml
53477       responses:
53478         "200":
53479           description: successful operation
53480           schema:
53481               $ref: "#/getDefinitions/evc"
53482         "default":
53483           description: Response codes found in [response codes](https://wiki.onap.org/).
53484       parameters:
53485         - name: configuration-id
53486           in: path
53487           description: UUID assigned to configuration.
53488           required: true
53489           type: string
53490           example: __CONFIGURATION-ID__
53491         - name: evc-id
53492           in: path
53493           description: Unique/key field for the evc object
53494           required: true
53495           type: string
53496           example: __EVC-ID__
53497         - name: model-invariant-id
53498           in: query
53499           description: the ASDC model id for this resource or service model.
53500           required: false
53501           type: string
53502         - name: model-version-id
53503           in: query
53504           description: the ASDC model version for this resource or service model.
53505           required: false
53506           type: string
53507     put:
53508       tags:
53509         - Network
53510       summary: create or update an existing evc
53511       description: |
53512         Create or update an existing evc.
53513         #
53514         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
53515       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
53516       consumes:
53517         - application/json
53518         - application/xml
53519       produces:
53520         - application/json
53521         - application/xml
53522       responses:
53523         "default":
53524           description: Response codes found in [response codes](https://wiki.onap.org/).
53525       parameters:
53526         - name: configuration-id
53527           in: path
53528           description: UUID assigned to configuration.
53529           required: true
53530           type: string
53531           example: __CONFIGURATION-ID__
53532         - name: evc-id
53533           in: path
53534           description: Unique/key field for the evc object
53535           required: true
53536           type: string
53537           example: __EVC-ID__
53538         - name: body
53539           in: body
53540           description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
53541           required: true
53542           schema:
53543             $ref: "#/definitions/evc"
53544     patch:
53545       tags:
53546         - Network
53547       summary: update an existing evc
53548       description: |
53549         Update an existing evc
53550         #
53551         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53552         The PUT operation will entirely replace an existing object.
53553         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.
53554         #
53555         Other differences between PUT and PATCH are:
53556         #
53557         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53558         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53559         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53560       operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
53561       consumes:
53562         - application/json
53563         - application/xml
53564       produces:
53565         - application/json
53566         - application/xml
53567       responses:
53568         "default":
53569           description: Response codes found in [response codes](https://wiki.onap.org/).
53570       parameters:
53571         - name: configuration-id
53572           in: path
53573           description: UUID assigned to configuration.
53574           required: true
53575           type: string
53576           example: __CONFIGURATION-ID__
53577         - name: evc-id
53578           in: path
53579           description: Unique/key field for the evc object
53580           required: true
53581           type: string
53582           example: __EVC-ID__
53583         - name: body
53584           in: body
53585           description: evc object that needs to be created or updated.
53586           required: true
53587           schema:
53588             $ref: "#/patchDefinitions/evc"
53589     delete:
53590       tags:
53591         - Network
53592       summary: delete an existing evc
53593       description: delete an existing evc
53594       operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
53595       consumes:
53596         - application/json
53597         - application/xml
53598       produces:
53599         - application/json
53600         - application/xml
53601       responses:
53602         "default":
53603           description: Response codes found in [response codes](https://wiki.onap.org/).
53604       parameters:
53605         - name: configuration-id
53606           in: path
53607           description: UUID assigned to configuration.
53608           required: true
53609           type: string
53610           example: __CONFIGURATION-ID__
53611         - name: evc-id
53612           in: path
53613           description: Unique/key field for the evc object
53614           required: true
53615           type: string
53616           example: __EVC-ID__
53617         - name: resource-version
53618           in: query
53619           description: resource-version for concurrency
53620           required: true
53621           type: string
53622   /network/configurations/configuration/{configuration-id}/evcs:
53623     get:
53624       tags:
53625         - Network
53626       summary: returns evcs
53627       description: returns evcs
53628       operationId: getNetworkConfigurationsConfigurationEvcs
53629       produces:
53630         - application/json
53631         - application/xml
53632       responses:
53633         "200":
53634           description: successful operation
53635           schema:
53636               $ref: "#/getDefinitions/evcs"
53637         "default":
53638           description: Response codes found in [response codes](https://wiki.onap.org/).
53639       parameters:
53640         - name: configuration-id
53641           in: path
53642           description: UUID assigned to configuration.
53643           required: true
53644           type: string
53645           example: __CONFIGURATION-ID__
53646         - name: model-invariant-id
53647           in: query
53648           description: the ASDC model id for this resource or service model.
53649           required: false
53650           type: string
53651         - name: model-version-id
53652           in: query
53653           description: the ASDC model version for this resource or service model.
53654           required: false
53655           type: string
53656   /network/configurations/configuration/{configuration-id}:
53657     get:
53658       tags:
53659         - Network
53660       summary: returns configuration
53661       description: returns configuration
53662       operationId: getNetworkConfigurationsConfiguration
53663       produces:
53664         - application/json
53665         - application/xml
53666       responses:
53667         "200":
53668           description: successful operation
53669           schema:
53670               $ref: "#/getDefinitions/configuration"
53671         "default":
53672           description: Response codes found in [response codes](https://wiki.onap.org/).
53673       parameters:
53674         - name: configuration-id
53675           in: path
53676           description: UUID assigned to configuration.
53677           required: true
53678           type: string
53679           example: __CONFIGURATION-ID__
53680         - name: model-invariant-id
53681           in: query
53682           description: the ASDC model id for this resource or service model.
53683           required: false
53684           type: string
53685         - name: model-version-id
53686           in: query
53687           description: the ASDC model version for this resource or service model.
53688           required: false
53689           type: string
53690     put:
53691       tags:
53692         - Network
53693       summary: create or update an existing configuration
53694       description: |
53695         Create or update an existing configuration.
53696         #
53697         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
53698       operationId: createOrUpdateNetworkConfigurationsConfiguration
53699       consumes:
53700         - application/json
53701         - application/xml
53702       produces:
53703         - application/json
53704         - application/xml
53705       responses:
53706         "default":
53707           description: Response codes found in [response codes](https://wiki.onap.org/).
53708       parameters:
53709         - name: configuration-id
53710           in: path
53711           description: UUID assigned to configuration.
53712           required: true
53713           type: string
53714           example: __CONFIGURATION-ID__
53715         - name: body
53716           in: body
53717           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
53718           required: true
53719           schema:
53720             $ref: "#/definitions/configuration"
53721     patch:
53722       tags:
53723         - Network
53724       summary: update an existing configuration
53725       description: |
53726         Update an existing configuration
53727         #
53728         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
53729         The PUT operation will entirely replace an existing object.
53730         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.
53731         #
53732         Other differences between PUT and PATCH are:
53733         #
53734         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
53735         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
53736         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
53737       operationId: UpdateNetworkConfigurationsConfiguration
53738       consumes:
53739         - application/json
53740         - application/xml
53741       produces:
53742         - application/json
53743         - application/xml
53744       responses:
53745         "default":
53746           description: Response codes found in [response codes](https://wiki.onap.org/).
53747       parameters:
53748         - name: configuration-id
53749           in: path
53750           description: UUID assigned to configuration.
53751           required: true
53752           type: string
53753           example: __CONFIGURATION-ID__
53754         - name: body
53755           in: body
53756           description: configuration object that needs to be created or updated.
53757           required: true
53758           schema:
53759             $ref: "#/patchDefinitions/configuration"
53760     delete:
53761       tags:
53762         - Network
53763       summary: delete an existing configuration
53764       description: delete an existing configuration
53765       operationId: deleteNetworkConfigurationsConfiguration
53766       consumes:
53767         - application/json
53768         - application/xml
53769       produces:
53770         - application/json
53771         - application/xml
53772       responses:
53773         "default":
53774           description: Response codes found in [response codes](https://wiki.onap.org/).
53775       parameters:
53776         - name: configuration-id
53777           in: path
53778           description: UUID assigned to configuration.
53779           required: true
53780           type: string
53781           example: __CONFIGURATION-ID__
53782         - name: resource-version
53783           in: query
53784           description: resource-version for concurrency
53785           required: true
53786           type: string
53787   /network/configurations:
53788     get:
53789       tags:
53790         - Network
53791       summary: returns configurations
53792       description: returns configurations
53793       operationId: getNetworkConfigurations
53794       produces:
53795         - application/json
53796         - application/xml
53797       responses:
53798         "200":
53799           description: successful operation
53800           schema:
53801               $ref: "#/getDefinitions/configurations"
53802         "default":
53803           description: Response codes found in [response codes](https://wiki.onap.org/).
53804   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
53805     put:
53806       tags:
53807         - Network
53808       summary: see node definition for valid relationships
53809       operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
53810       consumes:
53811         - application/json
53812         - application/xml
53813       produces:
53814         - application/json
53815         - application/xml
53816       responses:
53817         "default":
53818           description: Response codes found in [response codes](https://wiki.onap.org/).
53819       parameters:
53820         - name: forwarding-path-id
53821           in: path
53822           description: Unique ID of this FP
53823           required: true
53824           type: string
53825           example: __FORWARDING-PATH-ID__
53826         - name: body
53827           in: body
53828           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
53829           required: true
53830           schema:
53831             $ref: "#/definitions/relationship"
53832     delete:
53833       tags:
53834         - Network
53835       summary: delete an existing relationship
53836       description: delete an existing relationship
53837       operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
53838       consumes:
53839         - application/json
53840         - application/xml
53841       produces:
53842         - application/json
53843         - application/xml
53844       responses:
53845         "default":
53846           description: Response codes found in [response codes](https://wiki.onap.org/).
53847       parameters:
53848         - name: forwarding-path-id
53849           in: path
53850           description: Unique ID of this FP
53851           required: true
53852           type: string
53853           example: __FORWARDING-PATH-ID__
53854   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
53855     put:
53856       tags:
53857         - Network
53858       summary: see node definition for valid relationships
53859       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
53860       consumes:
53861         - application/json
53862         - application/xml
53863       produces:
53864         - application/json
53865         - application/xml
53866       responses:
53867         "default":
53868           description: Response codes found in [response codes](https://wiki.onap.org/).
53869       parameters:
53870         - name: forwarding-path-id
53871           in: path
53872           description: Unique ID of this FP
53873           required: true
53874           type: string
53875           example: __FORWARDING-PATH-ID__
53876         - name: sequence
53877           in: path
53878           description: Unique ID of this segmentation
53879           required: true
53880           type: integer
53881           format: int32
53882           example: __SEQUENCE__
53883         - name: body
53884           in: body
53885           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
53886           required: true
53887           schema:
53888             $ref: "#/definitions/relationship"
53889     delete:
53890       tags:
53891         - Network
53892       summary: delete an existing relationship
53893       description: delete an existing relationship
53894       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
53895       consumes:
53896         - application/json
53897         - application/xml
53898       produces:
53899         - application/json
53900         - application/xml
53901       responses:
53902         "default":
53903           description: Response codes found in [response codes](https://wiki.onap.org/).
53904       parameters:
53905         - name: forwarding-path-id
53906           in: path
53907           description: Unique ID of this FP
53908           required: true
53909           type: string
53910           example: __FORWARDING-PATH-ID__
53911         - name: sequence
53912           in: path
53913           description: Unique ID of this segmentation
53914           required: true
53915           type: integer
53916           format: int32
53917           example: __SEQUENCE__
53918   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
53919     get:
53920       tags:
53921         - Network
53922       summary: returns forwarder
53923       description: returns forwarder
53924       operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
53925       produces:
53926         - application/json
53927         - application/xml
53928       responses:
53929         "200":
53930           description: successful operation
53931           schema:
53932               $ref: "#/getDefinitions/forwarder"
53933         "default":
53934           description: Response codes found in [response codes](https://wiki.onap.org/).
53935       parameters:
53936         - name: forwarding-path-id
53937           in: path
53938           description: Unique ID of this FP
53939           required: true
53940           type: string
53941           example: __FORWARDING-PATH-ID__
53942         - name: sequence
53943           in: path
53944           description: Unique ID of this segmentation
53945           required: true
53946           type: integer
53947           format: int32
53948           example: __SEQUENCE__
53949         - name: forwarding-path-name
53950           in: query
53951           description: Name of the FP
53952           required: false
53953           type: string
53954     put:
53955       tags:
53956         - Network
53957       summary: create or update an existing forwarder
53958       description: |
53959         Create or update an existing forwarder.
53960         #
53961         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
53962       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
53963       consumes:
53964         - application/json
53965         - application/xml
53966       produces:
53967         - application/json
53968         - application/xml
53969       responses:
53970         "default":
53971           description: Response codes found in [response codes](https://wiki.onap.org/).
53972       parameters:
53973         - name: forwarding-path-id
53974           in: path
53975           description: Unique ID of this FP
53976           required: true
53977           type: string
53978           example: __FORWARDING-PATH-ID__
53979         - name: sequence
53980           in: path
53981           description: Unique ID of this segmentation
53982           required: true
53983           type: integer
53984           format: int32
53985           example: __SEQUENCE__
53986         - name: body
53987           in: body
53988           description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
53989           required: true
53990           schema:
53991             $ref: "#/definitions/forwarder"
53992     patch:
53993       tags:
53994         - Network
53995       summary: update an existing forwarder
53996       description: |
53997         Update an existing forwarder
53998         #
53999         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
54000         The PUT operation will entirely replace an existing object.
54001         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.
54002         #
54003         Other differences between PUT and PATCH are:
54004         #
54005         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
54006         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
54007         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
54008       operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
54009       consumes:
54010         - application/json
54011         - application/xml
54012       produces:
54013         - application/json
54014         - application/xml
54015       responses:
54016         "default":
54017           description: Response codes found in [response codes](https://wiki.onap.org/).
54018       parameters:
54019         - name: forwarding-path-id
54020           in: path
54021           description: Unique ID of this FP
54022           required: true
54023           type: string
54024           example: __FORWARDING-PATH-ID__
54025         - name: sequence
54026           in: path
54027           description: Unique ID of this segmentation
54028           required: true
54029           type: integer
54030           format: int32
54031           example: __SEQUENCE__
54032         - name: body
54033           in: body
54034           description: forwarder object that needs to be created or updated.
54035           required: true
54036           schema:
54037             $ref: "#/patchDefinitions/forwarder"
54038     delete:
54039       tags:
54040         - Network
54041       summary: delete an existing forwarder
54042       description: delete an existing forwarder
54043       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
54044       consumes:
54045         - application/json
54046         - application/xml
54047       produces:
54048         - application/json
54049         - application/xml
54050       responses:
54051         "default":
54052           description: Response codes found in [response codes](https://wiki.onap.org/).
54053       parameters:
54054         - name: forwarding-path-id
54055           in: path
54056           description: Unique ID of this FP
54057           required: true
54058           type: string
54059           example: __FORWARDING-PATH-ID__
54060         - name: sequence
54061           in: path
54062           description: Unique ID of this segmentation
54063           required: true
54064           type: integer
54065           format: int32
54066           example: __SEQUENCE__
54067         - name: resource-version
54068           in: query
54069           description: resource-version for concurrency
54070           required: true
54071           type: string
54072   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
54073     get:
54074       tags:
54075         - Network
54076       summary: returns forwarders
54077       description: returns forwarders
54078       operationId: getNetworkForwardingPathsForwardingPathForwarders
54079       produces:
54080         - application/json
54081         - application/xml
54082       responses:
54083         "200":
54084           description: successful operation
54085           schema:
54086               $ref: "#/getDefinitions/forwarders"
54087         "default":
54088           description: Response codes found in [response codes](https://wiki.onap.org/).
54089       parameters:
54090         - name: forwarding-path-id
54091           in: path
54092           description: Unique ID of this FP
54093           required: true
54094           type: string
54095           example: __FORWARDING-PATH-ID__
54096         - name: forwarding-path-name
54097           in: query
54098           description: Name of the FP
54099           required: false
54100           type: string
54101   /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
54102     get:
54103       tags:
54104         - Network
54105       summary: returns forwarding-path
54106       description: returns forwarding-path
54107       operationId: getNetworkForwardingPathsForwardingPath
54108       produces:
54109         - application/json
54110         - application/xml
54111       responses:
54112         "200":
54113           description: successful operation
54114           schema:
54115               $ref: "#/getDefinitions/forwarding-path"
54116         "default":
54117           description: Response codes found in [response codes](https://wiki.onap.org/).
54118       parameters:
54119         - name: forwarding-path-id
54120           in: path
54121           description: Unique ID of this FP
54122           required: true
54123           type: string
54124           example: __FORWARDING-PATH-ID__
54125         - name: forwarding-path-name
54126           in: query
54127           description: Name of the FP
54128           required: false
54129           type: string
54130     put:
54131       tags:
54132         - Network
54133       summary: create or update an existing forwarding-path
54134       description: |
54135         Create or update an existing forwarding-path.
54136         #
54137         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
54138       operationId: createOrUpdateNetworkForwardingPathsForwardingPath
54139       consumes:
54140         - application/json
54141         - application/xml
54142       produces:
54143         - application/json
54144         - application/xml
54145       responses:
54146         "default":
54147           description: Response codes found in [response codes](https://wiki.onap.org/).
54148       parameters:
54149         - name: forwarding-path-id
54150           in: path
54151           description: Unique ID of this FP
54152           required: true
54153           type: string
54154           example: __FORWARDING-PATH-ID__
54155         - name: body
54156           in: body
54157           description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
54158           required: true
54159           schema:
54160             $ref: "#/definitions/forwarding-path"
54161     patch:
54162       tags:
54163         - Network
54164       summary: update an existing forwarding-path
54165       description: |
54166         Update an existing forwarding-path
54167         #
54168         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
54169         The PUT operation will entirely replace an existing object.
54170         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.
54171         #
54172         Other differences between PUT and PATCH are:
54173         #
54174         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
54175         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
54176         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
54177       operationId: UpdateNetworkForwardingPathsForwardingPath
54178       consumes:
54179         - application/json
54180         - application/xml
54181       produces:
54182         - application/json
54183         - application/xml
54184       responses:
54185         "default":
54186           description: Response codes found in [response codes](https://wiki.onap.org/).
54187       parameters:
54188         - name: forwarding-path-id
54189           in: path
54190           description: Unique ID of this FP
54191           required: true
54192           type: string
54193           example: __FORWARDING-PATH-ID__
54194         - name: body
54195           in: body
54196           description: forwarding-path object that needs to be created or updated.
54197           required: true
54198           schema:
54199             $ref: "#/patchDefinitions/forwarding-path"
54200     delete:
54201       tags:
54202         - Network
54203       summary: delete an existing forwarding-path
54204       description: delete an existing forwarding-path
54205       operationId: deleteNetworkForwardingPathsForwardingPath
54206       consumes:
54207         - application/json
54208         - application/xml
54209       produces:
54210         - application/json
54211         - application/xml
54212       responses:
54213         "default":
54214           description: Response codes found in [response codes](https://wiki.onap.org/).
54215       parameters:
54216         - name: forwarding-path-id
54217           in: path
54218           description: Unique ID of this FP
54219           required: true
54220           type: string
54221           example: __FORWARDING-PATH-ID__
54222         - name: resource-version
54223           in: query
54224           description: resource-version for concurrency
54225           required: true
54226           type: string
54227   /network/forwarding-paths:
54228     get:
54229       tags:
54230         - Network
54231       summary: returns forwarding-paths
54232       description: returns forwarding-paths
54233       operationId: getNetworkForwardingPaths
54234       produces:
54235         - application/json
54236         - application/xml
54237       responses:
54238         "200":
54239           description: successful operation
54240           schema:
54241               $ref: "#/getDefinitions/forwarding-paths"
54242         "default":
54243           description: Response codes found in [response codes](https://wiki.onap.org/).
54244 definitions:
54245   aai-internal:
54246     properties:
54247       property-name:
54248         type: string
54249       property-value:
54250         type: string
54251   action:
54252     properties:
54253       action-type:
54254         type: string
54255       action-data:
54256         type: array
54257         items:
54258           $ref: "#/definitions/action-data"
54259   action-data:
54260     properties:
54261       property-name:
54262         type: string
54263       property-value:
54264         type: string
54265   actions:
54266     description: |
54267       APIs that are more action related than REST (e.g., notify, update).
54268     properties:
54269       update:
54270         type: object
54271         $ref: "#/definitions/update"
54272       notify:
54273         type: object
54274         $ref: "#/definitions/notify"
54275   allotted-resource:
54276     description: |
54277       Represents a slice or partial piece of a resource that gets separately allotted
54278       ###### Related Nodes
54279       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
54280       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
54281       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54282       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
54283       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
54284       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
54285       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
54286       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
54287       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54288       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
54289       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
54290       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
54291       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
54292       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
54293       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
54294     required:
54295     - id
54296     properties:
54297       id:
54298         type: string
54299         description: Allotted Resource id UUID assigned to this instance.
54300       description:
54301         type: string
54302         description: The descriptive information assigned to this allotted resource instance
54303       selflink:
54304         type: string
54305         description: Link back to more information in the controller
54306       model-invariant-id:
54307         type: string
54308         description: the ASDC model id for this resource or service model.
54309       model-version-id:
54310         type: string
54311         description: the ASDC model version for this resource or service model.
54312       persona-model-version:
54313         type: string
54314         description: the ASDC model version for this resource or service model.
54315       resource-version:
54316         type: string
54317         description: Concurrency value
54318       orchestration-status:
54319         type: string
54320         description: Orchestration status
54321       operational-status:
54322         type: string
54323         description: Indicator for whether the resource is considered operational
54324       type:
54325         type: string
54326         description: Generic description of the type of allotted resource.
54327       role:
54328         type: string
54329         description: role in the network that this resource will be providing.
54330       tunnel-xconnects:
54331         type: array
54332         items:
54333           $ref: "#/definitions/tunnel-xconnect"
54334       relationship-list:
54335         type: array
54336         items:
54337           $ref: "#/definitions/relationship"
54338   allotted-resources:
54339     description: |
54340       This object is used to store slices of services being offered
54341     properties:
54342       allotted-resource:
54343         type: array
54344         items:
54345           $ref: "#/definitions/allotted-resource"
54346   availability-zone:
54347     description: |
54348       Availability zone, a collection of compute hosts/pservers
54349       ###### Related Nodes
54350       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54351       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
54352       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54353       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54354       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54355       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54356       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
54357       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54358       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
54359     required:
54360     - availability-zone-name
54361     - hypervisor-type
54362     properties:
54363       availability-zone-name:
54364         type: string
54365         description: Name of the availability zone.  Unique across a cloud region
54366       hypervisor-type:
54367         type: string
54368         description: Type of hypervisor.  Source of truth should define valid values.
54369       operational-status:
54370         type: string
54371         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
54372       resource-version:
54373         type: string
54374         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54375       relationship-list:
54376         type: array
54377         items:
54378           $ref: "#/definitions/relationship"
54379   availability-zones:
54380     description: |
54381       Collection of availability zones
54382     properties:
54383       availability-zone:
54384         type: array
54385         items:
54386           $ref: "#/definitions/availability-zone"
54387   az-and-dvs-switches:
54388     properties:
54389       dvs-switches:
54390         type: object
54391         $ref: "#/definitions/dvs-switches"
54392       availability-zone:
54393         type: object
54394         $ref: "#/definitions/availability-zone"
54395   business:
54396     description: |
54397       Namespace for business related constructs
54398     properties:
54399       connectors:
54400         type: array
54401         items:
54402           $ref: "#/definitions/connector"
54403       customers:
54404         type: array
54405         items:
54406           $ref: "#/definitions/customer"
54407       lines-of-business:
54408         type: array
54409         items:
54410           $ref: "#/definitions/line-of-business"
54411       owning-entities:
54412         type: array
54413         items:
54414           $ref: "#/definitions/owning-entity"
54415       platforms:
54416         type: array
54417         items:
54418           $ref: "#/definitions/platform"
54419       projects:
54420         type: array
54421         items:
54422           $ref: "#/definitions/project"
54423   class-of-service:
54424     description: |
54425       ###### Related Nodes
54426       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
54427     required:
54428     - cos
54429     properties:
54430       cos:
54431         type: string
54432         description: unique identifier of probe
54433       probe-id:
54434         type: string
54435         description: identifier of probe
54436       probe-type:
54437         type: string
54438         description: type of probe
54439       resource-version:
54440         type: string
54441         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54442       relationship-list:
54443         type: array
54444         items:
54445           $ref: "#/definitions/relationship"
54446   classes-of-service:
54447     description: |
54448       class-of-service of probe
54449     properties:
54450       class-of-service:
54451         type: array
54452         items:
54453           $ref: "#/definitions/class-of-service"
54454   cloud-infrastructure:
54455     description: |
54456       Namespace for cloud infrastructure.
54457     properties:
54458       complexes:
54459         type: array
54460         items:
54461           $ref: "#/definitions/complex"
54462       cloud-regions:
54463         type: array
54464         items:
54465           $ref: "#/definitions/cloud-region"
54466       network-profiles:
54467         type: array
54468         items:
54469           $ref: "#/definitions/network-profile"
54470       pservers:
54471         type: array
54472         items:
54473           $ref: "#/definitions/pserver"
54474       virtual-data-centers:
54475         type: array
54476         items:
54477           $ref: "#/definitions/virtual-data-center"
54478       operational-environments:
54479         type: array
54480         items:
54481           $ref: "#/definitions/operational-environment"
54482   cloud-region:
54483     description: |
54484       cloud-region designates an installation of a cloud cluster or region or instantiation.
54485       ###### Related Nodes
54486       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
54487       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54488       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54489       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
54490       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54491       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54492       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54493       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54494       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54495       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54496       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54497       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54498       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54499       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54500       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54501       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54502       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
54503       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
54504       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
54505       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
54506       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54507     required:
54508     - cloud-owner
54509     - cloud-region-id
54510     - sriov-automation
54511     properties:
54512       cloud-owner:
54513         type: string
54514         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
54515       cloud-region-id:
54516         type: string
54517         description: Identifier used by the vendor for the region. Second part of composite key
54518       cloud-type:
54519         type: string
54520         description: Type of the cloud (e.g., openstack)
54521       owner-defined-type:
54522         type: string
54523         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
54524       cloud-region-version:
54525         type: string
54526         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
54527       identity-url:
54528         type: string
54529         description: URL of the keystone identity service
54530       cloud-zone:
54531         type: string
54532         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
54533       complex-name:
54534         type: string
54535         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
54536       sriov-automation:
54537         type: boolean
54538       cloud-extra-info:
54539         type: string
54540         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
54541       cloud-epa-caps:
54542         type: string
54543         description: MultiVIM will discover and expose EPA capabilities.
54544       resource-version:
54545         type: string
54546         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54547       volume-groups:
54548         type: array
54549         items:
54550           $ref: "#/definitions/volume-group"
54551       tenants:
54552         type: array
54553         items:
54554           $ref: "#/definitions/tenant"
54555       flavors:
54556         type: array
54557         items:
54558           $ref: "#/definitions/flavor"
54559       group-assignments:
54560         type: array
54561         items:
54562           $ref: "#/definitions/group-assignment"
54563       snapshots:
54564         type: array
54565         items:
54566           $ref: "#/definitions/snapshot"
54567       images:
54568         type: array
54569         items:
54570           $ref: "#/definitions/image"
54571       dvs-switches:
54572         type: array
54573         items:
54574           $ref: "#/definitions/dvs-switch"
54575       oam-networks:
54576         type: array
54577         items:
54578           $ref: "#/definitions/oam-network"
54579       availability-zones:
54580         type: array
54581         items:
54582           $ref: "#/definitions/availability-zone"
54583       relationship-list:
54584         type: array
54585         items:
54586           $ref: "#/definitions/relationship"
54587       vip-ipv4-address-list:
54588         type: array
54589         items:
54590           $ref: "#/definitions/vip-ipv4-address-list"
54591       vip-ipv6-address-list:
54592         type: array
54593         items:
54594           $ref: "#/definitions/vip-ipv6-address-list"
54595       hpa-capabilities:
54596         type: array
54597         items:
54598           $ref: "#/definitions/hpa-capability"
54599         description: List of cloud-region specific HPA Capabilities
54600   cloud-regions:
54601     properties:
54602       cloud-region:
54603         type: array
54604         items:
54605           $ref: "#/definitions/cloud-region"
54606   complex:
54607     description: |
54608       Collection of physical locations that can house cloud-regions.
54609       ###### Related Nodes
54610       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54611       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54612       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54613       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
54614       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
54615       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
54616       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54617       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54618       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
54619       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54620       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54621       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54622       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
54623       - COMPLEX is DELETED when these are DELETED CTAG-POOL
54624     required:
54625     - physical-location-id
54626     - physical-location-type
54627     - street1
54628     - city
54629     - postal-code
54630     - country
54631     - region
54632     properties:
54633       physical-location-id:
54634         type: string
54635         description: Unique identifier for physical location, e.g., CLLI
54636       data-center-code:
54637         type: string
54638         description: Data center code which can be an alternate way to identify a complex
54639       complex-name:
54640         type: string
54641         description: Gamma complex name for LCP instance.
54642       identity-url:
54643         type: string
54644         description: URL of the keystone identity service
54645       resource-version:
54646         type: string
54647         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54648       physical-location-type:
54649         type: string
54650         description: Type, e.g., central office, data center.
54651       street1:
54652         type: string
54653       street2:
54654         type: string
54655       city:
54656         type: string
54657       state:
54658         type: string
54659       postal-code:
54660         type: string
54661       country:
54662         type: string
54663       region:
54664         type: string
54665       latitude:
54666         type: string
54667       longitude:
54668         type: string
54669       elevation:
54670         type: string
54671       lata:
54672         type: string
54673       ctag-pools:
54674         type: array
54675         items:
54676           $ref: "#/definitions/ctag-pool"
54677       relationship-list:
54678         type: array
54679         items:
54680           $ref: "#/definitions/relationship"
54681   complexes:
54682     description: |
54683       Collection of physical locations that can house cloud-regions.
54684     properties:
54685       complex:
54686         type: array
54687         items:
54688           $ref: "#/definitions/complex"
54689   configuration:
54690     description: |
54691       Port Mirror Configuration.
54692       ###### Related Nodes
54693       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
54694       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54695       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
54696       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
54697       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
54698       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54699       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54700       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54701       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54702       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54703       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54704       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
54705       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
54706     required:
54707     - configuration-id
54708     - configuration-type
54709     - configuration-sub-type
54710     - orchestration-status
54711     - operational-status
54712     - configuration-selflink
54713     - model-customization-id
54714     properties:
54715       configuration-id:
54716         type: string
54717         description: UUID assigned to configuration.
54718       management-option:
54719         type: string
54720         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
54721       configuration-name:
54722         type: string
54723         description: Name of the configuration.
54724       configuration-type:
54725         type: string
54726         description: port-mirroring-configuration.
54727       configuration-sub-type:
54728         type: string
54729         description: vprobe, pprobe.
54730       model-invariant-id:
54731         type: string
54732         description: the ASDC model id for this resource or service model.
54733       model-version-id:
54734         type: string
54735         description: the ASDC model version for this resource or service model.
54736       orchestration-status:
54737         type: string
54738         description: Orchestration status of the configuration.
54739       operational-status:
54740         type: string
54741         description: Indicator for whether the resource is considered operational.
54742       configuration-selflink:
54743         type: string
54744         description: URL to endpoint where AAI can get more details from SDN-GC.
54745       model-customization-id:
54746         type: string
54747         description: id of  the configuration used to customize the resource
54748       tunnel-bandwidth:
54749         type: string
54750         description: DHV Site Effective Bandwidth
54751       vendor-allowed-max-bandwidth:
54752         type: string
54753         description: Velocloud Nominal Throughput - VNT
54754       resource-version:
54755         type: string
54756         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54757       relationship-list:
54758         type: array
54759         items:
54760           $ref: "#/definitions/relationship"
54761       metadata:
54762         type: array
54763         items:
54764           $ref: "#/definitions/metadatum"
54765       forwarder-evcs:
54766         type: array
54767         items:
54768           $ref: "#/definitions/forwarder-evc"
54769       evcs:
54770         type: array
54771         items:
54772           $ref: "#/definitions/evc"
54773   configurations:
54774     description: |
54775       Collection of configurations
54776     properties:
54777       configuration:
54778         type: array
54779         items:
54780           $ref: "#/definitions/configuration"
54781   connector:
54782     description: |
54783       Collection of resource instances used to connect a variety of disparate inventory widgets
54784       ###### Related Nodes
54785       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54786       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54787       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
54788       - CONNECTOR is DELETED when these are DELETED METADATUM
54789     required:
54790     - resource-instance-id
54791     properties:
54792       resource-instance-id:
54793         type: string
54794         description: Unique id of resource instance.
54795       resource-version:
54796         type: string
54797         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54798       model-invariant-id:
54799         type: string
54800         description: the ASDC model id for this resource or service model.
54801       model-version-id:
54802         type: string
54803         description: the ASDC model version for this resource or service model.
54804       persona-model-version:
54805         type: string
54806         description: the ASDC model version for this resource or service model.
54807       widget-model-id:
54808         type: string
54809         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54810       widget-model-version:
54811         type: string
54812         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54813       relationship-list:
54814         type: array
54815         items:
54816           $ref: "#/definitions/relationship"
54817       metadata:
54818         type: array
54819         items:
54820           $ref: "#/definitions/metadatum"
54821   connectors:
54822     description: |
54823       Collection of resource instances used to connect a variety of disparate inventory widgets
54824     properties:
54825       connector:
54826         type: array
54827         items:
54828           $ref: "#/definitions/connector"
54829   constrained-element-set:
54830     description: |
54831       This is how we would capture constraints defining allowed sets of elements.
54832       ###### Related Nodes
54833       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54834       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54835       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
54836       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
54837     required:
54838     - constrained-element-set-uuid
54839     - constraint-type
54840     - check-type
54841     properties:
54842       constrained-element-set-uuid:
54843         type: string
54844       constraint-type:
54845         type: string
54846       check-type:
54847         type: string
54848       resource-version:
54849         type: string
54850       element-choice-sets:
54851         type: array
54852         items:
54853           $ref: "#/definitions/element-choice-set"
54854       relationship-list:
54855         type: array
54856         items:
54857           $ref: "#/definitions/relationship"
54858   constrained-element-sets:
54859     properties:
54860       constrained-element-set:
54861         type: array
54862         items:
54863           $ref: "#/definitions/constrained-element-set"
54864   ctag-assignment:
54865     description: |
54866       ###### Related Nodes
54867       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54868       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
54869     required:
54870     - vlan-id-inner
54871     properties:
54872       vlan-id-inner:
54873         type: integer
54874         format: int64
54875         description: id.
54876       resource-version:
54877         type: string
54878         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54879       relationship-list:
54880         type: array
54881         items:
54882           $ref: "#/definitions/relationship"
54883   ctag-assignments:
54884     properties:
54885       ctag-assignment:
54886         type: array
54887         items:
54888           $ref: "#/definitions/ctag-assignment"
54889   ctag-pool:
54890     description: |
54891       A collection of C tags (vlan tags) grouped for a specific purpose.
54892       ###### Related Nodes
54893       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
54894       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54895       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
54896       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
54897     required:
54898     - target-pe
54899     - availability-zone-name
54900     - ctag-pool-purpose
54901     properties:
54902       target-pe:
54903         type: string
54904         description: The Target provider edge router
54905       availability-zone-name:
54906         type: string
54907         description: Name of the availability zone
54908       ctag-pool-purpose:
54909         type: string
54910         description: Describes what the intended purpose of this pool is.
54911       ctag-values:
54912         type: string
54913         description: Comma separated list of ctags
54914       resource-version:
54915         type: string
54916         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54917       relationship-list:
54918         type: array
54919         items:
54920           $ref: "#/definitions/relationship"
54921   ctag-pools:
54922     properties:
54923       ctag-pool:
54924         type: array
54925         items:
54926           $ref: "#/definitions/ctag-pool"
54927   customer:
54928     description: |
54929       customer identifiers to provide linkage back to BSS information.
54930       ###### Related Nodes
54931       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
54932       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
54933     required:
54934     - global-customer-id
54935     - subscriber-name
54936     - subscriber-type
54937     properties:
54938       global-customer-id:
54939         type: string
54940         description: Global customer id used across ECOMP to uniquely identify customer.
54941       subscriber-name:
54942         type: string
54943         description: Subscriber name, an alternate way to retrieve a customer.
54944       subscriber-type:
54945         type: string
54946         description: Subscriber type, a way to provide VID with only the INFRA customers.
54947       resource-version:
54948         type: string
54949         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54950       service-subscriptions:
54951         type: array
54952         items:
54953           $ref: "#/definitions/service-subscription"
54954       relationship-list:
54955         type: array
54956         items:
54957           $ref: "#/definitions/relationship"
54958   customers:
54959     description: |
54960       Collection of customer identifiers to provide linkage back to BSS information.
54961     properties:
54962       customer:
54963         type: array
54964         items:
54965           $ref: "#/definitions/customer"
54966   cvlan-tag-entry:
54967     required:
54968     - cvlan-tag
54969     properties:
54970       cvlan-tag:
54971         type: integer
54972         format: int64
54973         description: See mis-na-virtualization-platform.yang
54974       resource-version:
54975         type: string
54976         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54977       relationship-list:
54978         type: array
54979         items:
54980           $ref: "#/definitions/relationship"
54981   cvlan-tags:
54982     properties:
54983       cvlan-tag-entry:
54984         type: array
54985         items:
54986           $ref: "#/definitions/cvlan-tag-entry"
54987   dvs-switch:
54988     description: |
54989       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.
54990       ###### Related Nodes
54991       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54992       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54993     required:
54994     - switch-name
54995     - vcenter-url
54996     properties:
54997       switch-name:
54998         type: string
54999         description: DVS switch name
55000       vcenter-url:
55001         type: string
55002         description: URL used to reach the vcenter
55003       resource-version:
55004         type: string
55005         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55006       relationship-list:
55007         type: array
55008         items:
55009           $ref: "#/definitions/relationship"
55010   dvs-switches:
55011     description: |
55012       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
55013     properties:
55014       dvs-switch:
55015         type: array
55016         items:
55017           $ref: "#/definitions/dvs-switch"
55018   edge-prop-names:
55019     description: |
55020       Internal map to define the properties of an edge and interpret the map EdgeRules
55021     properties:
55022       edgeLabel:
55023         type: string
55024       direction:
55025         type: string
55026       multiplicityRule:
55027         type: string
55028       contains-other-v:
55029         type: string
55030       delete-other-v:
55031         type: string
55032       SVC-INFRA:
55033         type: string
55034       prevent-delete:
55035         type: string
55036       aai-uuid:
55037         type: string
55038   edge-tag-query-request:
55039     properties:
55040       edge-tag:
55041         type: string
55042       result-detail:
55043         type: string
55044       start-node-type:
55045         type: string
55046       start-node-filter:
55047         type: array
55048         items:
55049           $ref: "#/definitions/start-node-filter"
55050       include-node-filter:
55051         type: array
55052         items:
55053           $ref: "#/definitions/include-node-filter"
55054       secondary-filter:
55055         type: array
55056         items:
55057           $ref: "#/definitions/secondary-filter"
55058   edge-tag-query-result:
55059     properties:
55060       tagged-inventory-item-list:
55061         type: array
55062         items:
55063           $ref: "#/definitions/tagged-inventory-item-list"
55064   element-choice-set:
55065     description: |
55066       This is how we would capture constraints defining allowed sets of elements.
55067       ###### Related Nodes
55068       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
55069       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55070       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
55071     required:
55072     - element-choice-set-uuid
55073     - element-choice-set-name
55074     properties:
55075       element-choice-set-uuid:
55076         type: string
55077       element-choice-set-name:
55078         type: string
55079       cardinality:
55080         type: string
55081       resource-version:
55082         type: string
55083       model-elements:
55084         type: array
55085         items:
55086           $ref: "#/definitions/model-element"
55087       relationship-list:
55088         type: array
55089         items:
55090           $ref: "#/definitions/relationship"
55091   element-choice-sets:
55092     properties:
55093       element-choice-set:
55094         type: array
55095         items:
55096           $ref: "#/definitions/element-choice-set"
55097   entitlement:
55098     description: |
55099       Metadata for entitlement group.
55100       ###### Related Nodes
55101       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55102       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55103     required:
55104     - group-uuid
55105     - resource-uuid
55106     properties:
55107       group-uuid:
55108         type: string
55109         description: Unique ID for the entitlement group the resource comes from, should be uuid.
55110       resource-uuid:
55111         type: string
55112         description: Unique ID of an entitlement resource.
55113       resource-version:
55114         type: string
55115         description: Concurrency value
55116       relationship-list:
55117         type: array
55118         items:
55119           $ref: "#/definitions/relationship"
55120   entitlements:
55121     description: |
55122       Entitlements, keyed by group-uuid and resource-uuid, related to license management
55123     properties:
55124       entitlement:
55125         type: array
55126         items:
55127           $ref: "#/definitions/entitlement"
55128   esr-ems:
55129     description: |
55130       Persist EMS address information used by EMS driver.
55131       ###### Related Nodes
55132       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
55133       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
55134     required:
55135     - ems-id
55136     properties:
55137       ems-id:
55138         type: string
55139         description: Unique ID of EMS.
55140       resource-version:
55141         type: string
55142         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55143       esr-system-info-list:
55144         type: object
55145         $ref: "#/definitions/esr-system-info-list"
55146       relationship-list:
55147         type: object
55148         $ref: "#/definitions/relationship-list"
55149   esr-ems-list:
55150     properties:
55151       esr-ems:
55152         type: array
55153         items:
55154           $ref: "#/definitions/esr-ems"
55155   esr-system-info:
55156     description: |
55157       Persist common address information of external systems.
55158       ###### Related Nodes
55159       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
55160       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
55161       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
55162       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
55163     required:
55164     - esr-system-info-id
55165     - user-name
55166     - password
55167     - system-type
55168     properties:
55169       esr-system-info-id:
55170         type: string
55171         description: Unique ID of esr system info.
55172       system-name:
55173         type: string
55174         description: name of external system.
55175       type:
55176         type: string
55177         description: type of external systems.
55178       vendor:
55179         type: string
55180         description: vendor of external systems.
55181       version:
55182         type: string
55183         description: version of external systems.
55184       service-url:
55185         type: string
55186         description: url used to access external systems.
55187       user-name:
55188         type: string
55189         description: username used to access external systems.
55190       password:
55191         type: string
55192         description: password used to access external systems.
55193       system-type:
55194         type: string
55195         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
55196       protocol:
55197         type: string
55198         description: protocol of third party SDNC, for example netconf/snmp.
55199       ssl-cacert:
55200         type: string
55201         description: ca file content if enabled ssl on auth-url.
55202       ssl-insecure:
55203         type: boolean
55204         description: Whether to verify VIM's certificate.
55205       ip-address:
55206         type: string
55207         description: service IP of ftp server.
55208       port:
55209         type: string
55210         description: service port of ftp server.
55211       cloud-domain:
55212         type: string
55213         description: domain info for authentication.
55214       default-tenant:
55215         type: string
55216         description: default tenant of VIM.
55217       passive:
55218         type: boolean
55219         description: ftp passive mode or not.
55220       remote-path:
55221         type: string
55222         description: resource or performance data file path.
55223       system-status:
55224         type: string
55225         description: the status of external system.
55226       resource-version:
55227         type: string
55228         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55229       relationship-list:
55230         type: object
55231         $ref: "#/definitions/relationship-list"
55232   esr-system-info-list:
55233     description: |
55234       Collection of persistent block-level external system auth info.
55235     properties:
55236       esr-system-info:
55237         type: array
55238         items:
55239           $ref: "#/definitions/esr-system-info"
55240   esr-thirdparty-sdnc:
55241     description: |
55242       Persist SDNC address information used by ONAP SDNC.
55243       ###### Related Nodes
55244       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
55245       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
55246       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
55247     required:
55248     - thirdparty-sdnc-id
55249     properties:
55250       thirdparty-sdnc-id:
55251         type: string
55252         description: Unique ID of SDNC.
55253       location:
55254         type: string
55255         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
55256       product-name:
55257         type: string
55258         description: password used to access SDNC server.
55259       resource-version:
55260         type: string
55261         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55262       esr-system-info-list:
55263         type: object
55264         $ref: "#/definitions/esr-system-info-list"
55265       relationship-list:
55266         type: object
55267         $ref: "#/definitions/relationship-list"
55268   esr-thirdparty-sdnc-list:
55269     properties:
55270       esr-thirdparty-sdnc:
55271         type: array
55272         items:
55273           $ref: "#/definitions/esr-thirdparty-sdnc"
55274   esr-vnfm:
55275     description: |
55276       Persist VNFM address information used by VF-C.
55277       ###### Related Nodes
55278       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
55279       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
55280     required:
55281     - vnfm-id
55282     properties:
55283       vnfm-id:
55284         type: string
55285         description: Unique ID of VNFM.
55286       vim-id:
55287         type: string
55288         description: indecate the VIM to deploy VNF.
55289       certificate-url:
55290         type: string
55291         description: certificate url of VNFM.
55292       resource-version:
55293         type: string
55294         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55295       esr-system-info-list:
55296         type: object
55297         $ref: "#/definitions/esr-system-info-list"
55298       relationship-list:
55299         type: object
55300         $ref: "#/definitions/relationship-list"
55301   esr-vnfm-list:
55302     properties:
55303       esr-vnfm:
55304         type: array
55305         items:
55306           $ref: "#/definitions/esr-vnfm"
55307   evc:
55308     description: |
55309       evc object is an optional child object of the Configuration object.
55310       ###### Related Nodes
55311       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
55312     required:
55313     - evc-id
55314     properties:
55315       evc-id:
55316         type: string
55317         description: Unique/key field for the evc object
55318       forwarding-path-topology:
55319         type: string
55320         description: Point-to-Point, Multi-Point
55321       cir-value:
55322         type: string
55323         description: Commited Information Rate
55324       cir-units:
55325         type: string
55326         description: CIR units
55327       connection-diversity-group-id:
55328         type: string
55329         description: Diversity Group ID
55330       service-hours:
55331         type: string
55332         description: formerly Performance Group
55333       esp-evc-circuit-id:
55334         type: string
55335         description: EVC Circuit ID of ESP EVC
55336       esp-evc-cir-value:
55337         type: string
55338         description: Committed Information Rate (For ESP)
55339       esp-evc-cir-units:
55340         type: string
55341         description: CIR units (For ESP)
55342       esp-itu-code:
55343         type: string
55344         description: Identifies ESP
55345       collector-pop-clli:
55346         type: string
55347         description: Collector POP CLLI (from the hostname of the access pnf)
55348       inter-connect-type-ingress:
55349         type: string
55350         description: Interconnect type on ingress side of EVC.
55351       tagmode-access-ingress:
55352         type: string
55353         description: tagode for collector side of EVC
55354       tagmode-access-egress:
55355         type: string
55356         description: tagMode for network side of EVC
55357       relationship-list:
55358         type: array
55359         items:
55360           $ref: "#/definitions/relationship"
55361       resource-version:
55362         type: string
55363         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55364   evcs:
55365     properties:
55366       evc:
55367         type: array
55368         items:
55369           $ref: "#/definitions/evc"
55370   external-system:
55371     description: |
55372       Namespace for external system.
55373     properties:
55374       esr-ems-list:
55375         type: object
55376         $ref: "#/definitions/esr-ems-list"
55377       esr-vnfm-list:
55378         type: object
55379         $ref: "#/definitions/esr-vnfm-list"
55380       esr-thirdparty-sdnc-list:
55381         type: object
55382         $ref: "#/definitions/esr-thirdparty-sdnc-list"
55383   extra-properties:
55384     description: |
55385       Extra properties for inventory item for response list
55386     properties:
55387       extra-property:
55388         type: array
55389         items:
55390           $ref: "#/definitions/extra-property"
55391   extra-property:
55392     properties:
55393       property-name:
55394         type: string
55395       property-value:
55396         type: string
55397   flavor:
55398     description: |
55399       Openstack flavor.
55400       ###### Related Nodes
55401       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55402       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
55403       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
55404       - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
55405     required:
55406     - flavor-id
55407     - flavor-name
55408     - flavor-selflink
55409     properties:
55410       flavor-id:
55411         type: string
55412         description: Flavor id, expected to be unique across cloud-region.
55413       flavor-name:
55414         type: string
55415         description: Cloud Region Flavor name
55416       flavor-vcpus:
55417         type: integer
55418         format: int32
55419         description: Number of CPUs
55420       flavor-ram:
55421         type: integer
55422         format: int32
55423         description: Amount of memory
55424       flavor-disk:
55425         type: integer
55426         format: int32
55427         description: Disk space
55428       flavor-ephemeral:
55429         type: integer
55430         format: int32
55431         description: Amount of ephemeral disk space
55432       flavor-swap:
55433         type: string
55434         description: amount of swap space allocation
55435       flavor-is-public:
55436         type: boolean
55437         description: whether flavor is available to all users or private to the tenant it was created in.
55438       flavor-selflink:
55439         type: string
55440         description: URL to endpoint where AAI can get more details
55441       flavor-disabled:
55442         type: boolean
55443         description: Boolean as to whether this flavor is no longer enabled
55444       hpa-capabilities:
55445         type: array
55446         items:
55447           $ref: "#/definitions/hpa-capability"
55448         description: List of flavor specific HPA Capabilities
55449       resource-version:
55450         type: string
55451         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55452       relationship-list:
55453         type: array
55454         items:
55455           $ref: "#/definitions/relationship"
55456   flavors:
55457     description: |
55458       Collection of openstack flavors.
55459     properties:
55460       flavor:
55461         type: array
55462         items:
55463           $ref: "#/definitions/flavor"
55464   forwarder:
55465     description: |
55466       Entity describing a sequenced segment of forwarding path
55467       ###### Related Nodes
55468       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
55469       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
55470       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
55471       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
55472       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
55473       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
55474     required:
55475     - sequence
55476     properties:
55477       sequence:
55478         type: integer
55479         format: int32
55480         description: Unique ID of this segmentation
55481       forwarder-role:
55482         type: string
55483         description: ingress, intermediate, egress
55484       relationship-list:
55485         type: array
55486         items:
55487           $ref: "#/definitions/relationship"
55488       resource-version:
55489         type: string
55490         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55491   forwarder-evc:
55492     description: |
55493       forwarder object is an optional child object of the Configuration object.
55494       ###### Related Nodes
55495       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
55496     required:
55497     - forwarder-evc-id
55498     properties:
55499       forwarder-evc-id:
55500         type: string
55501         description: Key for forwarder-evc object
55502       circuit-id:
55503         type: string
55504         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
55505       ivlan:
55506         type: string
55507         description: Internal VLAN.
55508       svlan:
55509         type: string
55510         description: SVLAN value for ingress of egress forwarder.
55511       cvlan:
55512         type: string
55513         description: CVLAN value for ingress of egress forwarder.
55514       relationship-list:
55515         type: array
55516         items:
55517           $ref: "#/definitions/relationship"
55518       resource-version:
55519         type: string
55520         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55521   forwarder-evcs:
55522     properties:
55523       forwarder-evc:
55524         type: array
55525         items:
55526           $ref: "#/definitions/forwarder-evc"
55527   forwarders:
55528     properties:
55529       forwarder:
55530         type: array
55531         items:
55532           $ref: "#/definitions/forwarder"
55533   forwarding-path:
55534     description: |
55535       Entity that describes the sequenced forwarding path between interfaces of services or resources
55536       ###### Related Nodes
55537       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
55538       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
55539       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
55540       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
55541       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
55542     required:
55543     - forwarding-path-id
55544     - forwarding-path-name
55545     properties:
55546       forwarding-path-id:
55547         type: string
55548         description: Unique ID of this FP
55549       forwarding-path-name:
55550         type: string
55551         description: Name of the FP
55552       relationship-list:
55553         type: array
55554         items:
55555           $ref: "#/definitions/relationship"
55556       resource-version:
55557         type: string
55558         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55559       selflink:
55560         type: string
55561         description: the self link for this FP
55562       forwarders:
55563         type: array
55564         items:
55565           $ref: "#/definitions/forwarder"
55566   forwarding-paths:
55567     properties:
55568       forwarding-path:
55569         type: array
55570         items:
55571           $ref: "#/definitions/forwarding-path"
55572   generic-vnf:
55573     description: |
55574       General purpose VNF
55575       ###### Related Nodes
55576       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
55577       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
55578       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
55579       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
55580       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55581       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
55582       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55583       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
55584       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
55585       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
55586       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
55587       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
55588       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
55589       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
55590       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
55591       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
55592       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55593       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55594       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55595       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55596       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55597       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55598       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
55599       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55600       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55601       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55602       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
55603       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55604       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
55605       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
55606     required:
55607     - vnf-id
55608     - vnf-instance-id
55609     - vnf-name
55610     - vnf-type
55611     - vnf-package-name
55612     - vnf-discriptor-name
55613     - job-id
55614     - in-maint
55615     - is-closed-loop-disabled
55616     properties:
55617       vnf-id:
55618         type: string
55619         description: Unique id of VNF.  This is unique across the graph.
55620       vnf-instance-id:
55621         type: string
55622         description: vnf instance id.
55623       vnf-name:
55624         type: string
55625         description: Name of VNF.
55626       vnf-name2:
55627         type: string
55628         description: Alternate name of VNF.
55629       vnf-type:
55630         type: string
55631         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.
55632       service-id:
55633         type: string
55634         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
55635       regional-resource-zone:
55636         type: string
55637         description: Regional way of organizing pservers, source of truth should define values
55638       prov-status:
55639         type: string
55640         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55641       operational-status:
55642         type: string
55643         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
55644       license-key:
55645         type: string
55646         description: OBSOLETE -  do not use
55647       equipment-role:
55648         type: string
55649         description: Client should send valid enumerated value
55650       orchestration-status:
55651         type: string
55652         description: Orchestration status of this VNF, used by MSO.
55653       vnf-package-name:
55654         type: string
55655       vnf-discriptor-name:
55656         type: string
55657         description: vnf discriptor name
55658       job-id:
55659         type: string
55660         description: job id corresponding to vnf
55661       heat-stack-id:
55662         type: string
55663         description: Heat stack id corresponding to this instance, managed by MSO
55664       mso-catalog-key:
55665         type: string
55666         description: Corresponds to the SDN-C catalog id used to configure this VCE
55667       management-option:
55668         type: string
55669         description: identifier of managed by ATT or customer
55670       ipv4-oam-address:
55671         type: string
55672         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
55673       ipv4-loopback0-address:
55674         type: string
55675         description: v4 Loopback0 address
55676       nm-lan-v6-address:
55677         type: string
55678         description: v6 Loopback address
55679       management-v6-address:
55680         type: string
55681         description: v6 management address
55682       vcpu:
55683         type: integer
55684         format: int64
55685         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
55686       vcpu-units:
55687         type: string
55688         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
55689       vmemory:
55690         type: integer
55691         format: int64
55692         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
55693       vmemory-units:
55694         type: string
55695         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
55696       vdisk:
55697         type: integer
55698         format: int64
55699         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
55700       vdisk-units:
55701         type: string
55702         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
55703       nshd:
55704         type: integer
55705         format: int64
55706         description: number of associated SHD in vnf.
55707       nvm:
55708         type: integer
55709         format: int64
55710         description: number of vms in vnf.
55711       nnet:
55712         type: integer
55713         format: int64
55714         description: number of network in vnf.
55715       in-maint:
55716         type: boolean
55717       is-closed-loop-disabled:
55718         type: boolean
55719       resource-version:
55720         type: string
55721         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55722       summary-status:
55723         type: string
55724         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
55725       encrypted-access-flag:
55726         type: boolean
55727         description: indicates whether generic-vnf access uses SSH
55728       entitlement-assignment-group-uuid:
55729         type: string
55730         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
55731       entitlement-resource-uuid:
55732         type: string
55733         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
55734       license-assignment-group-uuid:
55735         type: string
55736         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
55737       license-key-uuid:
55738         type: string
55739         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
55740       model-invariant-id:
55741         type: string
55742         description: the ASDC model id for this resource or service model.
55743       model-version-id:
55744         type: string
55745         description: the ASDC model version for this resource or service model.
55746       persona-model-version:
55747         type: string
55748         description: the ASDC model version for this resource or service model.
55749       model-customization-id:
55750         type: string
55751         description: captures the id of all the configuration used to customize the resource for the service.
55752       widget-model-id:
55753         type: string
55754         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55755       widget-model-version:
55756         type: string
55757         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55758       as-number:
55759         type: string
55760         description: as-number of the VNF
55761       regional-resource-subzone:
55762         type: string
55763         description: represents sub zone of the rr plane
55764       nf-type:
55765         type: string
55766         description: Generic description of the type of NF
55767       nf-function:
55768         type: string
55769         description: English description of Network function that the specific VNF deployment is providing
55770       nf-role:
55771         type: string
55772         description: role in the network that this model will be providing
55773       nf-naming-code:
55774         type: string
55775         description: string assigned to this model used for naming purposes
55776       selflink:
55777         type: string
55778         description: Path to the controller object.
55779       ipv4-oam-gateway-address:
55780         type: string
55781         description: Gateway address
55782       ipv4-oam-gateway-address-prefix-length:
55783         type: integer
55784         format: int32
55785         description: Prefix length for oam-address
55786       vlan-id-outer:
55787         type: integer
55788         format: int64
55789         description: Temporary location for S-TAG to get to VCE
55790       nm-profile-name:
55791         type: string
55792         description: Network Management profile of this VNF
55793       relationship-list:
55794         type: array
55795         items:
55796           $ref: "#/definitions/relationship"
55797       l-interfaces:
55798         type: array
55799         items:
55800           $ref: "#/definitions/l-interface"
55801       lag-interfaces:
55802         type: array
55803         items:
55804           $ref: "#/definitions/lag-interface"
55805       vf-modules:
55806         type: array
55807         items:
55808           $ref: "#/definitions/vf-module"
55809       licenses:
55810         type: array
55811         items:
55812           $ref: "#/definitions/license"
55813       entitlements:
55814         type: array
55815         items:
55816           $ref: "#/definitions/entitlement"
55817   generic-vnfs:
55818     description: |
55819       Collection of VNFs
55820     properties:
55821       generic-vnf:
55822         type: array
55823         items:
55824           $ref: "#/definitions/generic-vnf"
55825   group-assignment:
55826     description: |
55827       Openstack group-assignment used to store exclusivity groups (EG).
55828       ###### Related Nodes
55829       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55830       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
55831       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
55832     required:
55833     - group-id
55834     - group-type
55835     - group-name
55836     properties:
55837       group-id:
55838         type: string
55839         description: Group id, expected to be unique across cloud-region.
55840       group-type:
55841         type: string
55842         description: Group type - the type of group this instance refers to
55843       group-name:
55844         type: string
55845         description: Group name - name assigned to the group
55846       group-description:
55847         type: string
55848         description: Group description - description of the group
55849       resource-version:
55850         type: string
55851         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55852       relationship-list:
55853         type: array
55854         items:
55855           $ref: "#/definitions/relationship"
55856   group-assignments:
55857     description: |
55858       Collection of openstack group assignments
55859     properties:
55860       group-assignment:
55861         type: array
55862         items:
55863           $ref: "#/definitions/group-assignment"
55864   host-route:
55865     description: |
55866       ###### Related Nodes
55867       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
55868     required:
55869     - host-route-id
55870     - route-prefix
55871     - next-hop
55872     properties:
55873       host-route-id:
55874         type: string
55875         description: host-route id
55876       route-prefix:
55877         type: string
55878         description: subnet prefix
55879       next-hop:
55880         type: string
55881         description: Could be ip-address, hostname, or service-instance
55882       next-hop-type:
55883         type: string
55884         description: Should be ip-address, hostname, or service-instance to match next-hop
55885       resource-version:
55886         type: string
55887         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55888       relationship-list:
55889         type: array
55890         items:
55891           $ref: "#/definitions/relationship"
55892   host-routes:
55893     properties:
55894       host-route:
55895         type: array
55896         items:
55897           $ref: "#/definitions/host-route"
55898   hpa-capabilities:
55899     description: |
55900       Collection of HPA Capabilities
55901     properties:
55902       hpa-capability:
55903         type: array
55904         items:
55905           $ref: "#/definitions/hpa-capability"
55906   hpa-capability:
55907     description: |
55908       Represents a HPA capability
55909       ###### Related Nodes
55910       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
55911       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55912       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
55913       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
55914     required:
55915     - hpa-capability-id
55916     - hpa-feature
55917     properties:
55918       hpa-capability-id:
55919         type: string
55920         description: UUID to uniquely identify a HPA capability
55921       hpa-feature:
55922         type: string
55923         description: Name of the HPACapability
55924       hpa-version:
55925         type: string
55926         description: HPA schema version
55927       hpa-hw-arch:
55928         type: string
55929         description: Hardware architecture
55930       resource-version:
55931         type: string
55932         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55933       relationship-list:
55934         type: array
55935         items:
55936           $ref: "#/definitions/relationship"
55937       hpa-feature-attributes:
55938         type: array
55939         items:
55940           $ref: "#/definitions/hpa-feature-attributes"
55941   hpa-feature-attributes:
55942     description: |
55943       HPA Capability Feature attributes
55944       ###### Related Nodes
55945       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
55946     properties:
55947       hpa-attr-key:
55948         type: string
55949         description: name of the specific HPA attribute
55950       hpa-attr-value:
55951         type: string
55952         description: JSON string specifying the value, unit and type of the specific HPA attribute
55953       resource-version:
55954         type: string
55955         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55956       relationship-list:
55957         type: array
55958         items:
55959           $ref: "#/definitions/relationship"
55960   image:
55961     description: |
55962       Openstack image.
55963       ###### Related Nodes
55964       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55965       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
55966       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
55967       - IMAGE cannot be deleted if linked to VSERVER
55968       - IMAGE is DELETED when these are DELETED METADATUM
55969     required:
55970     - image-id
55971     - image-name
55972     - image-os-distro
55973     - image-os-version
55974     - image-selflink
55975     properties:
55976       image-id:
55977         type: string
55978         description: Image id, expected to be unique across cloud region
55979       image-name:
55980         type: string
55981         description: Image name
55982       image-architecture:
55983         type: string
55984         description: Operating system architecture.
55985       image-os-distro:
55986         type: string
55987         description: The common name of the operating system distribution in lowercase
55988       image-os-version:
55989         type: string
55990         description: The operating system version as specified by the distributor.
55991       application:
55992         type: string
55993         description: The application that the image instantiates.
55994       application-vendor:
55995         type: string
55996         description: The vendor of the application.
55997       application-version:
55998         type: string
55999         description: The version of the application.
56000       image-selflink:
56001         type: string
56002         description: URL to endpoint where AAI can get more details
56003       resource-version:
56004         type: string
56005         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56006       relationship-list:
56007         type: array
56008         items:
56009           $ref: "#/definitions/relationship"
56010       metadata:
56011         type: array
56012         items:
56013           $ref: "#/definitions/metadatum"
56014   images:
56015     description: |
56016       Collectio of Openstack images.
56017     properties:
56018       image:
56019         type: array
56020         items:
56021           $ref: "#/definitions/image"
56022   include-node-filter:
56023     properties:
56024       include-node-type:
56025         type: string
56026   instance-filter:
56027     description: |
56028       InstanceFilter for performing a named-query or model query
56029   instance-filters:
56030     description: |
56031       InstanceFilters for performing a named-query or model query
56032     properties:
56033       instance-filter:
56034         type: array
56035         items:
56036           $ref: "#/definitions/instance-filter"
56037   instance-group:
56038     description: |
56039       General mechanism for grouping instances
56040       ###### Related Nodes
56041       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
56042       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56043       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56044       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56045       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56046       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56047       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56048       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56049       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56050       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56051       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56052       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56053     required:
56054     - instance-group-role
56055     - model-invariant-id
56056     - model-version-id
56057     - id
56058     - description
56059     - type
56060     properties:
56061       instance-group-role:
56062         type: string
56063         description: role of the instance group.
56064       model-invariant-id:
56065         type: string
56066         description: ASDC model id for this resource or service model.
56067       model-version-id:
56068         type: string
56069         description: ASDC model version uid for this resource model.
56070       id:
56071         type: string
56072         description: Instance Group ID, UUID assigned to this instance.
56073       description:
56074         type: string
56075         description: Descriptive text to help identify the usage of this instance-group
56076       type:
56077         type: string
56078         description: Only valid value today is lower case ha for high availability
56079       sub-type:
56080         type: string
56081         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
56082       resource-version:
56083         type: string
56084         description: Concurrency value
56085       relationship-list:
56086         type: array
56087         items:
56088           $ref: "#/definitions/relationship"
56089   instance-groups:
56090     description: |
56091       Collection of openstack route table references
56092     properties:
56093       instance-group:
56094         type: array
56095         items:
56096           $ref: "#/definitions/instance-group"
56097   inventory:
56098     properties:
56099       search:
56100         type: object
56101         $ref: "#/definitions/search"
56102       actions:
56103         type: object
56104         $ref: "#/definitions/actions"
56105       cloud-infrastructure:
56106         type: object
56107         $ref: "#/definitions/cloud-infrastructure"
56108       external-system:
56109         type: object
56110         $ref: "#/definitions/external-system"
56111       business:
56112         type: object
56113         $ref: "#/definitions/business"
56114       service-design-and-creation:
56115         type: object
56116         $ref: "#/definitions/service-design-and-creation"
56117       network:
56118         type: object
56119         $ref: "#/definitions/network"
56120       aai-internal:
56121         type: object
56122         $ref: "#/definitions/aai-internal"
56123       nodes:
56124         type: array
56125         items:
56126           $ref: "#/definitions/aai-internal"
56127   inventory-item:
56128     properties:
56129       inventory-item-type:
56130         type: string
56131       inventory-item-link:
56132         type: string
56133       inventory-item-data:
56134         type: array
56135         items:
56136           $ref: "#/definitions/inventory-item-data"
56137       tagged-inventory-item-list:
56138         type: array
56139         items:
56140           $ref: "#/definitions/tagged-inventory-item-list"
56141   inventory-item-data:
56142     properties:
56143       property-name:
56144         type: string
56145       property-value:
56146         type: string
56147   inventory-response-item:
56148     description: |
56149       Inventory item for response list
56150     properties:
56151       model-name:
56152         type: string
56153       extra-properties:
56154         type: object
56155         $ref: "#/definitions/extra-properties"
56156       inventory-response-items:
56157         type: object
56158         $ref: "#/definitions/inventory-response-items"
56159   inventory-response-items:
56160     description: |
56161       Container for inventory items in response list
56162     properties:
56163       inventory-response-item:
56164         type: array
56165         items:
56166           $ref: "#/definitions/inventory-response-item"
56167   ipsec-configuration:
56168     description: |
56169       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
56170       ###### Related Nodes
56171       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
56172       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
56173       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
56174     required:
56175     - ipsec-configuration-id
56176     properties:
56177       ipsec-configuration-id:
56178         type: string
56179         description: UUID of this configuration
56180       requested-vig-address-type:
56181         type: string
56182         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
56183       requested-encryption-strength:
56184         type: string
56185         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
56186       requested-dmz-type:
56187         type: string
56188         description: ATT can offer a shared DMZ or a DMZ specific to a customer
56189       shared-dmz-network-address:
56190         type: string
56191         description: Network address of shared DMZ
56192       requested-customer-name:
56193         type: string
56194         description: If the DMZ is a custom DMZ, this field will indicate the customer information
56195       ike-version:
56196         type: string
56197         description: can be 1 or 2
56198       ikev1-authentication:
56199         type: string
56200         description: Contains values like md5, sha1, sha256, sha384
56201       ikev1-encryption:
56202         type: string
56203         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
56204       ikev1-dh-group:
56205         type: string
56206         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
56207       ikev1-am-group-id:
56208         type: string
56209         description: Group name defined in VIG for clients using aggressive mode
56210       ikev1-am-password:
56211         type: string
56212         description: pre-shared key for the above group name
56213       ikev1-sa-lifetime:
56214         type: string
56215         description: Lifetime for IKEv1 SA
56216       ipsec-authentication:
56217         type: string
56218         description: md5, sha1, sha256, sha384
56219       ipsec-encryption:
56220         type: string
56221         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
56222       ipsec-sa-lifetime:
56223         type: string
56224         description: Life time for IPSec SA
56225       ipsec-pfs:
56226         type: string
56227         description: enable PFS or not
56228       xauth-userid:
56229         type: string
56230         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
56231       xauth-user-password:
56232         type: string
56233         description: Encrypted using the Juniper $9$ algorithm
56234       dpd-interval:
56235         type: string
56236         description: The time between DPD probe
56237       dpd-frequency:
56238         type: string
56239         description: Maximum number of DPD before claiming the tunnel is down
56240       resource-version:
56241         type: string
56242         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56243       relationship-list:
56244         type: array
56245         items:
56246           $ref: "#/definitions/relationship"
56247       vig-servers:
56248         type: array
56249         items:
56250           $ref: "#/definitions/vig-server"
56251   ipsec-configurations:
56252     properties:
56253       ipsec-configuration:
56254         type: array
56255         items:
56256           $ref: "#/definitions/ipsec-configuration"
56257   key-data:
56258     properties:
56259       key-name:
56260         type: string
56261       key-value:
56262         type: string
56263   l-interface:
56264     description: |
56265       Logical interfaces, e.g., a vnic.
56266       ###### Related Nodes
56267       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56268       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
56269       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56270       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56271       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
56272       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
56273       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
56274       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
56275       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
56276       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56277       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56278       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
56279       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
56280       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56281       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
56282       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
56283       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
56284       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56285       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
56286       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56287     required:
56288     - interface-name
56289     - is-port-mirrored
56290     - in-maint
56291     - is-ip-unnumbered
56292     properties:
56293       interface-name:
56294         type: string
56295         description: Name given to the interface
56296       interface-role:
56297         type: string
56298         description: E.g., CUSTOMER, UPLINK, etc.
56299       v6-wan-link-ip:
56300         type: string
56301         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
56302       selflink:
56303         type: string
56304         description: URL to endpoint where AAI can get more details
56305       interface-id:
56306         type: string
56307         description: ID of interface
56308       macaddr:
56309         type: string
56310         description: MAC address for the interface
56311       network-name:
56312         type: string
56313         description: Name of the network
56314       management-option:
56315         type: string
56316         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
56317       interface-description:
56318         type: string
56319         description: Human friendly text regarding this interface.
56320       is-port-mirrored:
56321         type: boolean
56322       resource-version:
56323         type: string
56324         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56325       in-maint:
56326         type: boolean
56327       prov-status:
56328         type: string
56329         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
56330       is-ip-unnumbered:
56331         type: boolean
56332       allowed-address-pairs:
56333         type: string
56334         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
56335       vlans:
56336         type: array
56337         items:
56338           $ref: "#/definitions/vlan"
56339       sriov-vfs:
56340         type: array
56341         items:
56342           $ref: "#/definitions/sriov-vf"
56343       l-interfaces:
56344         type: array
56345         items:
56346           $ref: "#/definitions/l-interface"
56347       relationship-list:
56348         type: array
56349         items:
56350           $ref: "#/definitions/relationship"
56351       l3-interface-ipv4-address-list:
56352         type: array
56353         items:
56354           $ref: "#/definitions/l3-interface-ipv4-address-list"
56355       l3-interface-ipv6-address-list:
56356         type: array
56357         items:
56358           $ref: "#/definitions/l3-interface-ipv6-address-list"
56359   l-interfaces:
56360     description: |
56361       Collection of logical interfaces.
56362     properties:
56363       l-interface:
56364         type: array
56365         items:
56366           $ref: "#/definitions/l-interface"
56367   l3-interface-ipv4-address-list:
56368     description: |
56369       IPv4 Address Range
56370       ###### Related Nodes
56371       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56372       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56373       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56374       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56375       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56376       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
56377     required:
56378     - l3-interface-ipv4-address
56379     properties:
56380       l3-interface-ipv4-address:
56381         type: string
56382         description: IP address
56383       l3-interface-ipv4-prefix-length:
56384         type: integer
56385         format: int64
56386         description: Prefix length, 32 for single address
56387       vlan-id-inner:
56388         type: integer
56389         format: int64
56390         description: Inner VLAN tag
56391       vlan-id-outer:
56392         type: integer
56393         format: int64
56394         description: Outer VLAN tag
56395       is-floating:
56396         type: boolean
56397         description: Indicator of fixed or floating address
56398       resource-version:
56399         type: string
56400         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56401       neutron-network-id:
56402         type: string
56403         description: Neutron network id of the interface that address belongs to
56404       neutron-subnet-id:
56405         type: string
56406         description: Neutron id of subnet that address belongs to
56407       relationship-list:
56408         type: array
56409         items:
56410           $ref: "#/definitions/relationship"
56411   l3-interface-ipv6-address-list:
56412     description: |
56413       IPv6 Address Range
56414       ###### Related Nodes
56415       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
56416       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56417       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56418       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
56419       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56420       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
56421     required:
56422     - l3-interface-ipv6-address
56423     properties:
56424       l3-interface-ipv6-address:
56425         type: string
56426         description: IP address
56427       l3-interface-ipv6-prefix-length:
56428         type: integer
56429         format: int64
56430         description: Prefix length, 128 for single address
56431       vlan-id-inner:
56432         type: integer
56433         format: int64
56434         description: Inner VLAN tag
56435       vlan-id-outer:
56436         type: integer
56437         format: int64
56438         description: Outer VLAN tag
56439       is-floating:
56440         type: boolean
56441         description: Indicator of fixed or floating address
56442       resource-version:
56443         type: string
56444         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56445       neutron-network-id:
56446         type: string
56447         description: Neutron network id of the interface that address belongs to
56448       neutron-subnet-id:
56449         type: string
56450         description: Neutron id of subnet that address belongs to
56451       relationship-list:
56452         type: array
56453         items:
56454           $ref: "#/definitions/relationship"
56455   l3-network:
56456     description: |
56457       Generic network definition
56458       ###### Related Nodes
56459       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56460       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
56461       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56462       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56463       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
56464       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
56465       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56466       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56467       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56468       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56469       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
56470       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56471       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56472       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56473       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56474       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56475       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
56476       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
56477     required:
56478     - network-id
56479     - network-name
56480     - is-bound-to-vpn
56481     - is-provider-network
56482     - is-shared-network
56483     - is-external-network
56484     properties:
56485       network-id:
56486         type: string
56487         description: Network ID, should be uuid. Unique across A&AI.
56488       network-name:
56489         type: string
56490         description: Name of the network, governed by some naming convention..
56491       network-type:
56492         type: string
56493         description: Type of the network - who defines these values?
56494       network-role:
56495         type: string
56496         description: Role the network plans - who defines these values?
56497       network-technology:
56498         type: string
56499         description: Network technology - who defines these values?
56500       neutron-network-id:
56501         type: string
56502         description: Neutron network id of this Interface
56503       is-bound-to-vpn:
56504         type: boolean
56505       service-id:
56506         type: string
56507         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
56508       network-role-instance:
56509         type: integer
56510         format: int64
56511         description: network role instance
56512       resource-version:
56513         type: string
56514         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56515       orchestration-status:
56516         type: string
56517         description: Orchestration status of this VNF, mastered by MSO
56518       heat-stack-id:
56519         type: string
56520         description: Heat stack id corresponding to this instance, managed by MSO
56521       mso-catalog-key:
56522         type: string
56523         description: Corresponds to the SDN-C catalog id used to configure this VCE
56524       contrail-network-fqdn:
56525         type: string
56526         description: Contrail FQDN for the network
56527       model-invariant-id:
56528         type: string
56529         description: the ASDC model id for this resource or service model.
56530       model-version-id:
56531         type: string
56532         description: the ASDC model version for this resource or service model.
56533       persona-model-version:
56534         type: string
56535         description: the ASDC model version for this resource or service model.
56536       model-customization-id:
56537         type: string
56538         description: captures the id of all the configuration used to customize the resource for the service.
56539       widget-model-id:
56540         type: string
56541         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56542       widget-model-version:
56543         type: string
56544         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56545       physical-network-name:
56546         type: string
56547         description: Name associated with the physical network.
56548       is-provider-network:
56549         type: boolean
56550       is-shared-network:
56551         type: boolean
56552       is-external-network:
56553         type: boolean
56554       selflink:
56555         type: string
56556         description: Path to the controller object.
56557       operational-status:
56558         type: string
56559         description: Indicator for whether the resource is considered operational.
56560       subnets:
56561         type: array
56562         items:
56563           $ref: "#/definitions/subnet"
56564       ctag-assignments:
56565         type: array
56566         items:
56567           $ref: "#/definitions/ctag-assignment"
56568       segmentation-assignments:
56569         type: array
56570         items:
56571           $ref: "#/definitions/segmentation-assignment"
56572       relationship-list:
56573         type: array
56574         items:
56575           $ref: "#/definitions/relationship"
56576         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
56577   l3-networks:
56578     properties:
56579       l3-network:
56580         type: array
56581         items:
56582           $ref: "#/definitions/l3-network"
56583   lag-interface:
56584     description: |
56585       Link aggregate interface
56586       ###### Related Nodes
56587       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56588       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
56589       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56590       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
56591       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56592       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56593       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56594       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
56595       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
56596       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
56597       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
56598     required:
56599     - interface-name
56600     - in-maint
56601     properties:
56602       interface-name:
56603         type: string
56604         description: Name that identifies the link aggregate interface
56605       interface-description:
56606         type: string
56607         description: Human friendly text regarding this interface.
56608       resource-version:
56609         type: string
56610         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56611       speed-value:
56612         type: string
56613         description: Captures the numeric part of the speed
56614       speed-units:
56615         type: string
56616         description: Captures the units corresponding to the speed
56617       interface-id:
56618         type: string
56619         description: ID of interface
56620       interface-role:
56621         type: string
56622         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
56623       prov-status:
56624         type: string
56625         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56626       in-maint:
56627         type: boolean
56628       relationship-list:
56629         type: array
56630         items:
56631           $ref: "#/definitions/relationship"
56632       l-interfaces:
56633         type: array
56634         items:
56635           $ref: "#/definitions/l-interface"
56636   lag-interfaces:
56637     description: |
56638       Collection of link aggregate interfaces.
56639     properties:
56640       lag-interface:
56641         type: array
56642         items:
56643           $ref: "#/definitions/lag-interface"
56644   lag-link:
56645     description: |
56646       LAG links can connect lag-interfaces
56647       ###### Related Nodes
56648       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
56649       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
56650     required:
56651     - link-name
56652     properties:
56653       link-name:
56654         type: string
56655         description: Alphabetical concatenation of lag-interface names
56656       resource-version:
56657         type: string
56658         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56659       relationship-list:
56660         type: array
56661         items:
56662           $ref: "#/definitions/relationship"
56663   lag-links:
56664     description: |
56665       Collection of link aggregation connections
56666     properties:
56667       lag-link:
56668         type: array
56669         items:
56670           $ref: "#/definitions/lag-link"
56671   license:
56672     description: |
56673       Metadata for license group.
56674       ###### Related Nodes
56675       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56676       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56677     required:
56678     - group-uuid
56679     - resource-uuid
56680     properties:
56681       group-uuid:
56682         type: string
56683         description: Unique ID for the license group the resource belongs to, should be uuid.
56684       resource-uuid:
56685         type: string
56686         description: Unique ID of a license resource.
56687       resource-version:
56688         type: string
56689         description: Concurrency value
56690       relationship-list:
56691         type: array
56692         items:
56693           $ref: "#/definitions/relationship"
56694   licenses:
56695     description: |
56696       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
56697     properties:
56698       license:
56699         type: array
56700         items:
56701           $ref: "#/definitions/license"
56702   line-of-business:
56703     description: |
56704       describes a line-of-business
56705       ###### Related Nodes
56706       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
56707     required:
56708     - line-of-business-name
56709     properties:
56710       line-of-business-name:
56711         type: string
56712         description: Name of the line-of-business (product)
56713       resource-version:
56714         type: string
56715         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56716       relationship-list:
56717         type: array
56718         items:
56719           $ref: "#/definitions/relationship"
56720   lines-of-business:
56721     description: |
56722       Collection of lines-of-business
56723     properties:
56724       line-of-business:
56725         type: array
56726         items:
56727           $ref: "#/definitions/line-of-business"
56728   logical-link:
56729     description: |
56730       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
56731       ###### Related Nodes
56732       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
56733       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
56734       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
56735       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
56736       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
56737       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56738       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
56739       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
56740       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56741       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56742       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
56743       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56744       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56745       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
56746       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
56747       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56748       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56749       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56750     required:
56751     - link-name
56752     - in-maint
56753     - link-type
56754     properties:
56755       link-name:
56756         type: string
56757         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
56758       in-maint:
56759         type: boolean
56760       link-type:
56761         type: string
56762         description: Type of logical link, e.g., evc
56763       speed-value:
56764         type: string
56765         description: Captures the numeric part of the speed
56766       speed-units:
56767         type: string
56768         description: Captures the units corresponding to the speed
56769       ip-version:
56770         type: string
56771         description: v4, v6, or ds for dual stack
56772       routing-protocol:
56773         type: string
56774         description: For example, static or BGP
56775       resource-version:
56776         type: string
56777         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56778       model-invariant-id:
56779         type: string
56780         description: the ASDC model id for this resource or service model.
56781       model-version-id:
56782         type: string
56783         description: the ASDC model version for this resource or service model.
56784       persona-model-version:
56785         type: string
56786         description: the ASDC model version for this resource or service model.
56787       widget-model-id:
56788         type: string
56789         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56790       widget-model-version:
56791         type: string
56792         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56793       operational-status:
56794         type: string
56795         description: Indication of operational status of the logical link.
56796       prov-status:
56797         type: string
56798         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56799       link-role:
56800         type: string
56801         description: Indication of the network use of the logical link.
56802       link-name2:
56803         type: string
56804         description: Alias or alternate name (CLCI or D1 name).
56805       link-id:
56806         type: string
56807         description: UUID of the logical-link, SDNC generates this.
56808       circuit-id:
56809         type: string
56810         description: Circuit id
56811       purpose:
56812         type: string
56813         description: Reason for this entity, role it is playing
56814       relationship-list:
56815         type: array
56816         items:
56817           $ref: "#/definitions/relationship"
56818   logical-links:
56819     description: |
56820       Collection of logical connections
56821     properties:
56822       logical-link:
56823         type: array
56824         items:
56825           $ref: "#/definitions/logical-link"
56826   metadata:
56827     description: |
56828       Collection of metadatum (key/value pairs)
56829     properties:
56830       metadatum:
56831         type: array
56832         items:
56833           $ref: "#/definitions/metadatum"
56834   metadatum:
56835     description: |
56836       Key/value pairs
56837       ###### Related Nodes
56838       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
56839       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
56840       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
56841       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
56842       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56843     required:
56844     - metaname
56845     - metaval
56846     properties:
56847       metaname:
56848         type: string
56849       metaval:
56850         type: string
56851       resource-version:
56852         type: string
56853         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56854   model:
56855     description: |
56856       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
56857       ###### Related Nodes
56858       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
56859       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
56860       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
56861       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
56862       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
56863       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
56864       - MODEL is DELETED when these are DELETED MODEL-VER
56865     required:
56866     - model-invariant-id
56867     - model-type
56868     properties:
56869       model-invariant-id:
56870         type: string
56871         description: Unique identifier corresponding to the main definition of a model in ASDC
56872       model-type:
56873         type: string
56874         description: Type of the model, e.g., service, resource, widget, etc.
56875       resource-version:
56876         type: string
56877         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56878       model-vers:
56879         type: array
56880         items:
56881           $ref: "#/definitions/model-ver"
56882       relationship-list:
56883         type: array
56884         items:
56885           $ref: "#/definitions/relationship"
56886   model-and-named-query-search:
56887     description: |
56888       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
56889     properties:
56890       query-parameters:
56891         type: object
56892         $ref: "#/definitions/query-parameters"
56893       instance-filters:
56894         type: object
56895         $ref: "#/definitions/instance-filters"
56896       secondary-filts:
56897         type: object
56898         $ref: "#/definitions/secondary-filts"
56899       top-node-type:
56900         type: string
56901       secondary-filter-cut-point:
56902         type: string
56903   model-constraint:
56904     description: |
56905       This is how we would capture constraints defining allowed sets of elements.
56906       ###### Related Nodes
56907       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
56908       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
56909       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
56910     required:
56911     - model-constraint-uuid
56912     - constrained-element-set-uuid-to-replace
56913     properties:
56914       model-constraint-uuid:
56915         type: string
56916       constrained-element-set-uuid-to-replace:
56917         type: string
56918       constrained-element-sets:
56919         type: array
56920         items:
56921           $ref: "#/definitions/constrained-element-set"
56922       resource-version:
56923         type: string
56924         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56925   model-constraints:
56926     properties:
56927       model-constraint:
56928         type: array
56929         items:
56930           $ref: "#/definitions/model-constraint"
56931   model-element:
56932     description: |
56933       Defines how other models combine to make up a higher-level model.
56934       ###### Related Nodes
56935       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
56936       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
56937       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
56938       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
56939       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
56940       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
56941       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
56942       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
56943     required:
56944     - model-element-uuid
56945     - new-data-del-flag
56946     - cardinality
56947     properties:
56948       model-element-uuid:
56949         type: string
56950       new-data-del-flag:
56951         type: string
56952         description: Indicates whether this element was created as part of instantiation from this model
56953       cardinality:
56954         type: string
56955         description: How many of this type of element are required/allowed
56956       linkage-points:
56957         type: string
56958       resource-version:
56959         type: string
56960         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56961       model-elements:
56962         type: array
56963         items:
56964           $ref: "#/definitions/model-element"
56965         description: Defines how other models combine to make up a higher-level model
56966       model-constraints:
56967         type: array
56968         items:
56969           $ref: "#/definitions/model-constraint"
56970         description: Describes new constraints on this model element that are not part of that model's definition
56971       relationship-list:
56972         type: array
56973         items:
56974           $ref: "#/definitions/relationship"
56975   model-elements:
56976     properties:
56977       model-element:
56978         type: array
56979         items:
56980           $ref: "#/definitions/model-element"
56981   model-ver:
56982     description: |
56983       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
56984       ###### Related Nodes
56985       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
56986       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
56987       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
56988       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
56989       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
56990       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
56991       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
56992       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
56993       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
56994       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
56995       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
56996       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
56997     required:
56998     - model-version-id
56999     - model-name
57000     - model-version
57001     properties:
57002       model-version-id:
57003         type: string
57004         description: Unique identifier corresponding to one version of a model in ASDC
57005       model-name:
57006         type: string
57007         description: Name of the model, which can change from version to version.
57008       model-version:
57009         type: string
57010         description: Version
57011       distribution-status:
57012         type: string
57013         description: Distribution Status
57014       model-description:
57015         type: string
57016         description: Description
57017       resource-version:
57018         type: string
57019         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57020       model-elements:
57021         type: array
57022         items:
57023           $ref: "#/definitions/model-element"
57024       metadata:
57025         type: array
57026         items:
57027           $ref: "#/definitions/metadatum"
57028       relationship-list:
57029         type: array
57030         items:
57031           $ref: "#/definitions/relationship"
57032   model-vers:
57033     properties:
57034       model-ver:
57035         type: array
57036         items:
57037           $ref: "#/definitions/model-ver"
57038   models:
57039     description: |
57040       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
57041     properties:
57042       model:
57043         type: array
57044         items:
57045           $ref: "#/definitions/model"
57046   multicast-configuration:
57047     description: |
57048       ###### Related Nodes
57049       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57050     required:
57051     - multicast-configuration-id
57052     - multicast-protocol
57053     - rp-type
57054     properties:
57055       multicast-configuration-id:
57056         type: string
57057         description: Unique id of multicast configuration.
57058       multicast-protocol:
57059         type: string
57060         description: protocol of multicast configuration
57061       rp-type:
57062         type: string
57063         description: rp type of multicast configuration
57064       resource-version:
57065         type: string
57066         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57067       relationship-list:
57068         type: array
57069         items:
57070           $ref: "#/definitions/relationship"
57071   multicast-configurations:
57072     description: |
57073       multicast configuration of generic-vnf ip-address
57074     properties:
57075       multicast-configuration:
57076         type: array
57077         items:
57078           $ref: "#/definitions/multicast-configuration"
57079   named-queries:
57080     properties:
57081       named-query:
57082         type: array
57083         items:
57084           $ref: "#/definitions/named-query"
57085   named-query:
57086     description: |
57087       TBD
57088       ###### Related Nodes
57089       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
57090       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
57091       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
57092       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
57093     required:
57094     - named-query-uuid
57095     - named-query-name
57096     - named-query-version
57097     properties:
57098       named-query-uuid:
57099         type: string
57100       named-query-name:
57101         type: string
57102       named-query-version:
57103         type: string
57104       required-input-param:
57105         type: string
57106       description:
57107         type: string
57108       resource-version:
57109         type: string
57110       named-query-elements:
57111         type: array
57112         items:
57113           $ref: "#/definitions/named-query-element"
57114       relationship-list:
57115         type: array
57116         items:
57117           $ref: "#/definitions/relationship"
57118   named-query-element:
57119     description: |
57120       TBD
57121       ###### Related Nodes
57122       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
57123       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
57124       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57125       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57126       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57127       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57128       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
57129     required:
57130     - named-query-element-uuid
57131     properties:
57132       named-query-element-uuid:
57133         type: string
57134       property-collect-list:
57135         type: string
57136       resource-version:
57137         type: string
57138       property-limit-desc:
57139         type: string
57140       do-not-output:
57141         type: string
57142       named-query-elements:
57143         type: array
57144         items:
57145           $ref: "#/definitions/named-query-element"
57146       related-lookups:
57147         type: array
57148         items:
57149           $ref: "#/definitions/related-lookup"
57150       property-constraints:
57151         type: array
57152         items:
57153           $ref: "#/definitions/property-constraint"
57154       relationship-list:
57155         type: array
57156         items:
57157           $ref: "#/definitions/relationship"
57158   named-query-elements:
57159     properties:
57160       named-query-element:
57161         type: array
57162         items:
57163           $ref: "#/definitions/named-query-element"
57164   network:
57165     description: |
57166       Namespace for network inventory resources.
57167     properties:
57168       logical-links:
57169         type: array
57170         items:
57171           $ref: "#/definitions/logical-link"
57172       site-pair-sets:
57173         type: array
57174         items:
57175           $ref: "#/definitions/site-pair-set"
57176       vpn-bindings:
57177         type: array
57178         items:
57179           $ref: "#/definitions/vpn-binding"
57180       vpls-pes:
57181         type: array
57182         items:
57183           $ref: "#/definitions/vpls-pe"
57184       multicast-configurations:
57185         type: array
57186         items:
57187           $ref: "#/definitions/multicast-configuration"
57188       vces:
57189         type: array
57190         items:
57191           $ref: "#/definitions/vce"
57192       vnfcs:
57193         type: array
57194         items:
57195           $ref: "#/definitions/vnfc"
57196       l3-networks:
57197         type: array
57198         items:
57199           $ref: "#/definitions/l3-network"
57200       network-policies:
57201         type: array
57202         items:
57203           $ref: "#/definitions/network-policy"
57204       generic-vnfs:
57205         type: array
57206         items:
57207           $ref: "#/definitions/generic-vnf"
57208       lag-links:
57209         type: array
57210         items:
57211           $ref: "#/definitions/lag-link"
57212       newvces:
57213         type: array
57214         items:
57215           $ref: "#/definitions/newvce"
57216       pnfs:
57217         type: array
57218         items:
57219           $ref: "#/definitions/pnf"
57220       physical-links:
57221         type: array
57222         items:
57223           $ref: "#/definitions/physical-link"
57224       ipsec-configurations:
57225         type: array
57226         items:
57227           $ref: "#/definitions/ipsec-configuration"
57228       route-table-references:
57229         type: array
57230         items:
57231           $ref: "#/definitions/route-table-reference"
57232       instance-groups:
57233         type: array
57234         items:
57235           $ref: "#/definitions/instance-group"
57236       zones:
57237         type: array
57238         items:
57239           $ref: "#/definitions/zone"
57240       configurations:
57241         type: array
57242         items:
57243           $ref: "#/definitions/configuration"
57244       forwarding-paths:
57245         type: array
57246         items:
57247           $ref: "#/definitions/forwarding-path"
57248   network-policies:
57249     properties:
57250       network-policy:
57251         type: array
57252         items:
57253           $ref: "#/definitions/network-policy"
57254   network-policy:
57255     description: |
57256       ###### Related Nodes
57257       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
57258       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
57259     required:
57260     - network-policy-id
57261     properties:
57262       network-policy-id:
57263         type: string
57264         description: UUID representing unique key to this instance
57265       network-policy-fqdn:
57266         type: string
57267         description: Contrail FQDN for the policy
57268       heat-stack-id:
57269         type: string
57270         description: ID for the openStack Heat instance
57271       resource-version:
57272         type: string
57273         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57274       relationship-list:
57275         type: array
57276         items:
57277           $ref: "#/definitions/relationship"
57278   network-profile:
57279     description: |
57280       Network profile populated by SDN-GP for SNMP
57281       ###### Related Nodes
57282       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
57283     required:
57284     - nm-profile-name
57285     properties:
57286       nm-profile-name:
57287         type: string
57288         description: Unique name of network profile.
57289       community-string:
57290         type: string
57291         description: Encrypted SNMP community string
57292       resource-version:
57293         type: string
57294         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57295       relationship-list:
57296         type: array
57297         items:
57298           $ref: "#/definitions/relationship"
57299   network-profiles:
57300     description: |
57301       Collection of network profiles
57302     properties:
57303       network-profile:
57304         type: array
57305         items:
57306           $ref: "#/definitions/network-profile"
57307   newvce:
57308     description: |
57309       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
57310       ###### Related Nodes
57311       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
57312       - NEWVCE is DELETED when these are DELETED L-INTERFACE
57313     required:
57314     - vnf-id2
57315     - vnf-name
57316     - vnf-type
57317     properties:
57318       vnf-id2:
57319         type: string
57320         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
57321       vnf-name:
57322         type: string
57323         description: Name of VNF.
57324       vnf-name2:
57325         type: string
57326         description: Alternate name of VNF.
57327       vnf-type:
57328         type: string
57329         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.
57330       prov-status:
57331         type: string
57332         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57333       operational-status:
57334         type: string
57335         description: Indicator for whether the resource is considered operational
57336       license-key:
57337         type: string
57338         description: OBSOLETE -  do not use
57339       ipv4-oam-address:
57340         type: string
57341         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).
57342       equipment-role:
57343         type: string
57344         description: Client should send valid enumerated value.
57345       resource-version:
57346         type: string
57347         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57348       ipv4-loopback0-address:
57349         type: string
57350         description: v4 Loopback0 address
57351       orchestration-status:
57352         type: string
57353         description: Orchestration status of this VNF, mastered by MSO.
57354       heat-stack-id:
57355         type: string
57356         description: Heat stack id corresponding to this instance, managed by MSO
57357       mso-catalog-key:
57358         type: string
57359         description: Corresponds to the SDN-C catalog id used to configure this VCE
57360       relationship-list:
57361         type: array
57362         items:
57363           $ref: "#/definitions/relationship"
57364       l-interfaces:
57365         type: array
57366         items:
57367           $ref: "#/definitions/l-interface"
57368   newvces:
57369     description: |
57370       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
57371     properties:
57372       newvce:
57373         type: array
57374         items:
57375           $ref: "#/definitions/newvce"
57376   notification-event:
57377     properties:
57378       cambria.partition:
57379         type: string
57380       notification-event-header:
57381         type: object
57382         $ref: "#/definitions/notification-event-header"
57383   notification-event-header:
57384     properties:
57385       id:
57386         type: string
57387       timestamp:
57388         type: string
57389       source-name:
57390         type: string
57391       domain:
57392         type: string
57393       sequence-number:
57394         type: string
57395       severity:
57396         type: string
57397       event-type:
57398         type: string
57399       version:
57400         type: string
57401       action:
57402         type: string
57403       entity-type:
57404         type: string
57405       top-entity-type:
57406         type: string
57407       entity-link:
57408         type: string
57409       status:
57410         type: string
57411   notify:
57412     required:
57413     - event-id
57414     properties:
57415       event-id:
57416         type: string
57417       node-type:
57418         type: string
57419       event-trigger:
57420         type: string
57421       key-data:
57422         type: array
57423         items:
57424           $ref: "#/definitions/key-data"
57425       selflink:
57426         type: string
57427   oam-network:
57428     description: |
57429       OAM network, to be deprecated shortly.  Do not use for new purposes.
57430       ###### Related Nodes
57431       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57432       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
57433       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57434     required:
57435     - network-uuid
57436     - network-name
57437     - cvlan-tag
57438     properties:
57439       network-uuid:
57440         type: string
57441         description: UUID of the network. Unique across a cloud-region
57442       network-name:
57443         type: string
57444         description: Name of the network.
57445       cvlan-tag:
57446         type: integer
57447         format: int64
57448         description: cvlan-id
57449       ipv4-oam-gateway-address:
57450         type: string
57451         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
57452       ipv4-oam-gateway-address-prefix-length:
57453         type: integer
57454         format: int32
57455         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
57456       resource-version:
57457         type: string
57458         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57459       relationship-list:
57460         type: array
57461         items:
57462           $ref: "#/definitions/relationship"
57463   oam-networks:
57464     description: |
57465       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
57466     properties:
57467       oam-network:
57468         type: array
57469         items:
57470           $ref: "#/definitions/oam-network"
57471   operational-environment:
57472     description: |
57473       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
57474       ###### Related Nodes
57475       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
57476       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
57477     required:
57478     - operational-environment-id
57479     - operational-environment-name
57480     - operational-environment-type
57481     - operational-environment-status
57482     - tenant-context
57483     - workload-context
57484     properties:
57485       operational-environment-id:
57486         type: string
57487         description: UUID of an operational environment
57488       operational-environment-name:
57489         type: string
57490         description: Operational Environment name
57491       operational-environment-type:
57492         type: string
57493         description: Operational Environment Type.
57494       operational-environment-status:
57495         type: string
57496         description: Status
57497       tenant-context:
57498         type: string
57499         description: Tenant Context.
57500       workload-context:
57501         type: string
57502         description: Workload Context.
57503       resource-version:
57504         type: string
57505         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57506       relationship-list:
57507         type: array
57508         items:
57509           $ref: "#/definitions/relationship"
57510   operational-environments:
57511     description: |
57512       a logical partition of the cloud which allows to have multiple environments in the production AIC.
57513     properties:
57514       operational-environment:
57515         type: array
57516         items:
57517           $ref: "#/definitions/operational-environment"
57518   overloaded-model:
57519     description: |
57520       Allows for legacy POST of old-style and new-style models
57521     required:
57522     - model-invariant-id
57523     - model-name-version-id
57524     - model-type
57525     - model-name
57526     - model-id
57527     - model-version
57528     properties:
57529       model-invariant-id:
57530         type: string
57531         description: Unique identifier corresponding to the main definition of a model in ASDC
57532       model-name-version-id:
57533         type: string
57534         description: Unique identifier corresponding to one version of a model in ASDC
57535       model-type:
57536         type: string
57537         description: Type of the model, e.g., service, resource, widget, etc.
57538       model-name:
57539         type: string
57540         description: Name of the model, which can change from version to version.
57541       model-id:
57542         type: string
57543         description: Invariant unique ID which does not change from version to version
57544       model-version:
57545         type: string
57546         description: Version
57547       model-description:
57548         type: string
57549         description: Description
57550       resource-version:
57551         type: string
57552         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57553       model-vers:
57554         type: object
57555         $ref: "#/definitions/model-vers"
57556       relationship-list:
57557         type: object
57558         $ref: "#/definitions/relationship-list"
57559   owning-entities:
57560     description: |
57561       Collection of owning-entities
57562     properties:
57563       owning-entity:
57564         type: array
57565         items:
57566           $ref: "#/definitions/owning-entity"
57567   owning-entity:
57568     description: |
57569       describes an owning-entity
57570       ###### Related Nodes
57571       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
57572     required:
57573     - owning-entity-id
57574     - owning-entity-name
57575     properties:
57576       owning-entity-id:
57577         type: string
57578         description: UUID of an owning entity
57579       owning-entity-name:
57580         type: string
57581         description: Owning entity name
57582       resource-version:
57583         type: string
57584         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57585       relationship-list:
57586         type: array
57587         items:
57588           $ref: "#/definitions/relationship"
57589   p-interface:
57590     description: |
57591       Physical interface (e.g., nic)
57592       ###### Related Nodes
57593       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
57594       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
57595       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
57596       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
57597       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57598       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
57599       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
57600       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
57601       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
57602       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
57603       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
57604     required:
57605     - interface-name
57606     - in-maint
57607     properties:
57608       interface-name:
57609         type: string
57610         description: Name that identifies the physical interface
57611       selflink:
57612         type: string
57613         description: URL to endpoint where AAI can get more details.
57614       speed-value:
57615         type: string
57616         description: Captures the numeric part of the speed
57617       speed-units:
57618         type: string
57619         description: Captures the units corresponding to the speed
57620       port-description:
57621         type: string
57622         description: Nature of the services and connectivity on this port.
57623       equipment-identifier:
57624         type: string
57625         description: CLEI or other specification for p-interface hardware.
57626       interface-role:
57627         type: string
57628         description: Role specification for p-interface hardware.
57629       interface-type:
57630         type: string
57631         description: Indicates the physical properties of the interface.
57632       prov-status:
57633         type: string
57634         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57635       mac-addresss:
57636         type: string
57637         description: MAC Address of the p-interface.
57638       resource-version:
57639         type: string
57640         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57641       in-maint:
57642         type: boolean
57643       inv-status:
57644         type: string
57645         description: inventory status
57646       relationship-list:
57647         type: array
57648         items:
57649           $ref: "#/definitions/relationship"
57650       sriov-pfs:
57651         type: array
57652         items:
57653           $ref: "#/definitions/sriov-pf"
57654       l-interfaces:
57655         type: array
57656         items:
57657           $ref: "#/definitions/l-interface"
57658   p-interfaces:
57659     description: |
57660       Collection of physical interfaces.
57661     properties:
57662       p-interface:
57663         type: array
57664         items:
57665           $ref: "#/definitions/p-interface"
57666   physical-link:
57667     description: |
57668       Collection of physical connections, typically between p-interfaces
57669       ###### Related Nodes
57670       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
57671     required:
57672     - link-name
57673     properties:
57674       link-name:
57675         type: string
57676         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
57677       speed-value:
57678         type: string
57679         description: Captures the numeric part of the speed
57680       speed-units:
57681         type: string
57682         description: Captures the units corresponding to the speed
57683       circuit-id:
57684         type: string
57685         description: Circuit it
57686       dual-mode:
57687         type: string
57688         description: Dual access mode (e.g., primary, secondary
57689       management-option:
57690         type: string
57691         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
57692       service-provider-name:
57693         type: string
57694         description: Name of the service Provider on this link.
57695       service-provider-bandwidth-up-value:
57696         type: integer
57697         format: int32
57698         description: Upstream Bandwidth value agreed with the service provider
57699       service-provider-bandwidth-up-units:
57700         type: string
57701         description: Units for the upstream BW value
57702       service-provider-bandwidth-down-value:
57703         type: integer
57704         format: int32
57705         description: Downstream Bandwidth value agreed with the service provider
57706       service-provider-bandwidth-down-units:
57707         type: string
57708         description: Units for downstream BW value
57709       resource-version:
57710         type: string
57711         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57712       relationship-list:
57713         type: array
57714         items:
57715           $ref: "#/definitions/relationship"
57716   physical-links:
57717     description: |
57718       Collection of physical connections, typically between p-interfaces
57719     properties:
57720       physical-link:
57721         type: array
57722         items:
57723           $ref: "#/definitions/physical-link"
57724   platform:
57725     description: |
57726       describes a platform
57727       ###### Related Nodes
57728       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
57729     required:
57730     - platform-name
57731     properties:
57732       platform-name:
57733         type: string
57734         description: Name of the platform
57735       resource-version:
57736         type: string
57737         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57738       relationship-list:
57739         type: array
57740         items:
57741           $ref: "#/definitions/relationship"
57742   platforms:
57743     description: |
57744       Collection of platforms
57745     properties:
57746       platform:
57747         type: array
57748         items:
57749           $ref: "#/definitions/platform"
57750   pnf:
57751     description: |
57752       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.
57753       ###### Related Nodes
57754       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57755       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57756       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57757       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
57758       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
57759       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
57760       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
57761       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
57762       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
57763       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
57764       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57765     required:
57766     - pnf-name
57767     - in-maint
57768     properties:
57769       pnf-name:
57770         type: string
57771         description: unique name of Physical Network Function.
57772       pnf-name2:
57773         type: string
57774         description: name of Physical Network Function.
57775       selflink:
57776         type: string
57777         description: URL to endpoint where AAI can get more details.
57778       pnf-name2-source:
57779         type: string
57780         description: source of name2
57781       pnf-id:
57782         type: string
57783         description: id of pnf
57784       equip-type:
57785         type: string
57786         description: Equipment type.  Source of truth should define valid values.
57787       equip-vendor:
57788         type: string
57789         description: Equipment vendor.  Source of truth should define valid values.
57790       equip-model:
57791         type: string
57792         description: Equipment model.  Source of truth should define valid values.
57793       management-option:
57794         type: string
57795         description: identifier of managed by ATT or customer
57796       ipaddress-v4-oam:
57797         type: string
57798         description: ipv4-oam-address with new naming convention for IP addresses
57799       sw-version:
57800         type: string
57801         description: sw-version is the version of SW for the hosted application on the PNF.
57802       in-maint:
57803         type: boolean
57804       frame-id:
57805         type: string
57806         description: ID of the physical frame (relay rack) where pnf is installed.
57807       serial-number:
57808         type: string
57809         description: Serial number of the device
57810       ipaddress-v4-loopback-0:
57811         type: string
57812         description: IPV4 Loopback 0 address
57813       ipaddress-v6-loopback-0:
57814         type: string
57815         description: IPV6 Loopback 0 address
57816       ipaddress-v4-aim:
57817         type: string
57818         description: IPV4 AIM address
57819       ipaddress-v6-aim:
57820         type: string
57821         description: IPV6 AIM address
57822       ipaddress-v6-oam:
57823         type: string
57824         description: IPV6 OAM address
57825       inv-status:
57826         type: string
57827         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
57828       resource-version:
57829         type: string
57830         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57831       prov-status:
57832         type: string
57833         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
57834       nf-role:
57835         type: string
57836         description: Nf Role is the role performed by this instance in the network.
57837       relationship-list:
57838         type: array
57839         items:
57840           $ref: "#/definitions/relationship"
57841       p-interfaces:
57842         type: array
57843         items:
57844           $ref: "#/definitions/p-interface"
57845       lag-interfaces:
57846         type: array
57847         items:
57848           $ref: "#/definitions/lag-interface"
57849   pnfs:
57850     description: |
57851       Collection of Physical Network Functions.
57852     properties:
57853       pnf:
57854         type: array
57855         items:
57856           $ref: "#/definitions/pnf"
57857   port-group:
57858     description: |
57859       Used to capture the network interfaces of this VCE
57860       ###### Related Nodes
57861       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57862       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
57863       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
57864     required:
57865     - interface-id
57866     - orchestration-status
57867     properties:
57868       interface-id:
57869         type: string
57870         description: Unique ID of the interface
57871       neutron-network-id:
57872         type: string
57873         description: Neutron network id of this Interface
57874       neutron-network-name:
57875         type: string
57876         description: Neutron network name of this Interface
57877       interface-role:
57878         type: string
57879         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
57880       resource-version:
57881         type: string
57882         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57883       port-group-id:
57884         type: string
57885         description: Unique ID for port group in vmware
57886       port-group-name:
57887         type: string
57888         description: Likely to duplicate value of neutron network name
57889       switch-name:
57890         type: string
57891         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
57892       orchestration-status:
57893         type: string
57894         description: Orchestration status of this VNF, mastered by MSO
57895       heat-stack-id:
57896         type: string
57897         description: Heat stack id corresponding to this instance, managed by MSO
57898       mso-catalog-key:
57899         type: string
57900         description: Corresponds to the SDN-C catalog id used to configure this VCE
57901       cvlan-tags:
57902         type: array
57903         items:
57904           $ref: "#/definitions/cvlan-tag-entry"
57905       relationship-list:
57906         type: array
57907         items:
57908           $ref: "#/definitions/relationship"
57909   port-groups:
57910     properties:
57911       port-group:
57912         type: array
57913         items:
57914           $ref: "#/definitions/port-group"
57915   project:
57916     description: |
57917       describes the project
57918       ###### Related Nodes
57919       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
57920     required:
57921     - project-name
57922     properties:
57923       project-name:
57924         type: string
57925         description: Name of the project deploying a service
57926       resource-version:
57927         type: string
57928         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57929       relationship-list:
57930         type: array
57931         items:
57932           $ref: "#/definitions/relationship"
57933   projects:
57934     description: |
57935       Collection of projects
57936     properties:
57937       project:
57938         type: array
57939         items:
57940           $ref: "#/definitions/project"
57941   properties:
57942     description: |
57943       Property holder for query properties or instance properties
57944     properties:
57945       property-name:
57946         type: string
57947       property-value:
57948         type: string
57949   property-constraint:
57950     description: |
57951       TBD
57952       ###### Related Nodes
57953       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
57954     required:
57955     - property-constraint-uuid
57956     - constraint-type
57957     - property-name
57958     - property-value
57959     properties:
57960       property-constraint-uuid:
57961         type: string
57962       constraint-type:
57963         type: string
57964       property-name:
57965         type: string
57966       property-value:
57967         type: string
57968       resource-version:
57969         type: string
57970   property-constraints:
57971     properties:
57972       property-constraint:
57973         type: array
57974         items:
57975           $ref: "#/definitions/property-constraint"
57976   pserver:
57977     description: |
57978       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
57979       ###### Related Nodes
57980       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
57981       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
57982       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
57983       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57984       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57985       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
57986       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
57987       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
57988       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
57989       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57990       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
57991       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57992       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
57993     required:
57994     - hostname
57995     - in-maint
57996     properties:
57997       hostname:
57998         type: string
57999         description: Value from executing hostname on the compute node.
58000       ptnii-equip-name:
58001         type: string
58002         description: PTNII name
58003       number-of-cpus:
58004         type: integer
58005         format: int32
58006         description: Number of cpus
58007       disk-in-gigabytes:
58008         type: integer
58009         format: int32
58010         description: Disk size, in GBs
58011       ram-in-megabytes:
58012         type: integer
58013         format: int32
58014         description: RAM size, in MBs
58015       equip-type:
58016         type: string
58017         description: Equipment type.  Source of truth should define valid values.
58018       equip-vendor:
58019         type: string
58020         description: Equipment vendor.  Source of truth should define valid values.
58021       equip-model:
58022         type: string
58023         description: Equipment model.  Source of truth should define valid values.
58024       fqdn:
58025         type: string
58026         description: Fully-qualified domain name
58027       pserver-selflink:
58028         type: string
58029         description: URL to endpoint where AAI can get more details
58030       ipv4-oam-address:
58031         type: string
58032         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
58033       serial-number:
58034         type: string
58035         description: Serial number, may be queried
58036       ipaddress-v4-loopback-0:
58037         type: string
58038         description: IPV4 Loopback 0 address
58039       ipaddress-v6-loopback-0:
58040         type: string
58041         description: IPV6 Loopback 0 address
58042       ipaddress-v4-aim:
58043         type: string
58044         description: IPV4 AIM address
58045       ipaddress-v6-aim:
58046         type: string
58047         description: IPV6 AIM address
58048       ipaddress-v6-oam:
58049         type: string
58050         description: IPV6 OAM address
58051       inv-status:
58052         type: string
58053         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
58054       pserver-id:
58055         type: string
58056         description: ID of Pserver
58057       internet-topology:
58058         type: string
58059         description: internet topology of Pserver
58060       in-maint:
58061         type: boolean
58062       resource-version:
58063         type: string
58064         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58065       pserver-name2:
58066         type: string
58067         description: alternative pserver name
58068       purpose:
58069         type: string
58070         description: purpose of pserver
58071       prov-status:
58072         type: string
58073         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
58074       management-option:
58075         type: string
58076         description: Indicates who owns and or manages the device.
58077       host-profile:
58078         type: string
58079         description: The host profile that defines the configuration of the pserver.
58080       relationship-list:
58081         type: array
58082         items:
58083           $ref: "#/definitions/relationship"
58084       p-interfaces:
58085         type: array
58086         items:
58087           $ref: "#/definitions/p-interface"
58088       lag-interfaces:
58089         type: array
58090         items:
58091           $ref: "#/definitions/lag-interface"
58092   pservers:
58093     description: |
58094       Collection of compute hosts.
58095     properties:
58096       pserver:
58097         type: array
58098         items:
58099           $ref: "#/definitions/pserver"
58100   query-parameters:
58101     description: |
58102       QueryParameters for performing a named-query or model query
58103     properties:
58104       named-query:
58105         type: object
58106         $ref: "#/definitions/named-query"
58107       overloaded-model:
58108         type: object
58109         $ref: "#/definitions/overloaded-model"
58110   related-lookup:
58111     description: |
58112       TBD
58113       ###### Related Nodes
58114       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
58115     required:
58116     - related-lookup-uuid
58117     - source-node-type
58118     - source-node-property
58119     - target-node-type
58120     - target-node-property
58121     properties:
58122       related-lookup-uuid:
58123         type: string
58124       source-node-type:
58125         type: string
58126       source-node-property:
58127         type: string
58128       target-node-type:
58129         type: string
58130       target-node-property:
58131         type: string
58132       property-collect-list:
58133         type: string
58134       resource-version:
58135         type: string
58136       relationship-list:
58137         type: array
58138         items:
58139           $ref: "#/definitions/relationship"
58140   related-lookups:
58141     properties:
58142       related-lookup:
58143         type: array
58144         items:
58145           $ref: "#/definitions/related-lookup"
58146   related-to-property:
58147     properties:
58148       property-key:
58149         type: string
58150         description: Key part of a key/value pair
58151       property-value:
58152         type: string
58153         description: Value part of a key/value pair
58154   relationship:
58155     properties:
58156       related-to:
58157         type: string
58158         description: A keyword provided by A&AI to indicate type of node.
58159       relationship-label:
58160         type: string
58161         description: The edge label for this relationship.
58162       related-link:
58163         type: string
58164         description: URL to the object in A&AI.
58165       relationship-data:
58166         type: array
58167         items:
58168           $ref: "#/definitions/relationship-data"
58169   relationship-data:
58170     required:
58171     - relationship-key
58172     - relationship-value
58173     properties:
58174       relationship-key:
58175         type: string
58176         description: A keyword provided by A&AI to indicate an attribute.
58177       relationship-value:
58178         type: string
58179         description: Value of the attribute.
58180   relationship-list:
58181     properties:
58182       relationship:
58183         type: array
58184         items:
58185           $ref: "#/definitions/relationship"
58186   reserved-prop-names:
58187     description: |
58188       Internal map to define some reserved properties of a vertex
58189     properties:
58190       last-mod-source-of-truth:
58191         type: string
58192       aai-node-type:
58193         type: string
58194       aai-created-ts:
58195         type: integer
58196         format: int64
58197       aai-unique-key:
58198         type: string
58199       aai-last-mod-ts:
58200         type: integer
58201         format: int64
58202       source-of-truth:
58203         type: string
58204       aai-uri:
58205         type: string
58206   response-list:
58207     description: |
58208       Response container for the results of a named-query or model query
58209     properties:
58210       inventory-response-items:
58211         type: object
58212         $ref: "#/definitions/inventory-response-items"
58213   result-data:
58214     properties:
58215       resource-type:
58216         type: string
58217         description: The specific type of node in the A&AI graph
58218       resource-link:
58219         type: string
58220         description: The URL to the specific resource
58221   route-table-reference:
58222     description: |
58223       Openstack route table reference.
58224       ###### Related Nodes
58225       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
58226     required:
58227     - route-table-reference-id
58228     - route-table-reference-fqdn
58229     properties:
58230       route-table-reference-id:
58231         type: string
58232         description: Route Table Reference id, UUID assigned to this instance.
58233       route-table-reference-fqdn:
58234         type: string
58235         description: FQDN entry in the route table.
58236       resource-version:
58237         type: string
58238         description: Concurrency value
58239       relationship-list:
58240         type: array
58241         items:
58242           $ref: "#/definitions/relationship"
58243   route-table-references:
58244     description: |
58245       Collection of openstack route table references
58246     properties:
58247       route-table-reference:
58248         type: array
58249         items:
58250           $ref: "#/definitions/route-table-reference"
58251   route-target:
58252     description: |
58253       Route target information
58254       ###### Related Nodes
58255       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
58256     required:
58257     - global-route-target
58258     - route-target-role
58259     properties:
58260       global-route-target:
58261         type: string
58262         description: Number used to identify an RT, globally unique in the network
58263       route-target-role:
58264         type: string
58265         description: Role assigned to this route target
58266       resource-version:
58267         type: string
58268         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58269       relationship-list:
58270         type: array
58271         items:
58272           $ref: "#/definitions/relationship"
58273   route-targets:
58274     description: |
58275       Collection of route target information
58276     properties:
58277       route-target:
58278         type: array
58279         items:
58280           $ref: "#/definitions/route-target"
58281   routing-instance:
58282     description: |
58283       ###### Related Nodes
58284       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
58285       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
58286       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
58287     required:
58288     - routing-instance-id
58289     properties:
58290       routing-instance-id:
58291         type: string
58292         description: Unique id of routing instance
58293       rpm-owner:
58294         type: string
58295         description: rpm owner
58296       resource-version:
58297         type: string
58298         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58299       site-pairs:
58300         type: array
58301         items:
58302           $ref: "#/definitions/site-pair"
58303       relationship-list:
58304         type: array
58305         items:
58306           $ref: "#/definitions/relationship"
58307   routing-instances:
58308     description: |
58309       set of probes related to generic-vnf routing instance
58310     properties:
58311       routing-instance:
58312         type: array
58313         items:
58314           $ref: "#/definitions/routing-instance"
58315   sdn-zone-response:
58316     properties:
58317       oam-networks:
58318         type: object
58319         $ref: "#/definitions/oam-networks"
58320       az-and-dvs-switches:
58321         type: array
58322         items:
58323           $ref: "#/definitions/az-and-dvs-switches"
58324   search:
58325     properties:
58326       edge-tag-query-result:
58327         type: object
58328         $ref: "#/definitions/edge-tag-query-result"
58329       edge-tag-query-request:
58330         type: object
58331         $ref: "#/definitions/edge-tag-query-request"
58332       search-results:
58333         type: object
58334         $ref: "#/definitions/search-results"
58335       sdn-zone-response:
58336         type: object
58337         $ref: "#/definitions/sdn-zone-response"
58338   search-results:
58339     properties:
58340       result-data:
58341         type: array
58342         items:
58343           $ref: "#/definitions/result-data"
58344   secondary-filt:
58345     description: |
58346       SecondaryFilt for performing a named-query or model query
58347   secondary-filter:
58348     properties:
58349       property-name:
58350         type: string
58351       filter-type:
58352         type: string
58353       property-value:
58354         type: string
58355   secondary-filts:
58356     description: |
58357       SecondaryFilts for performing a named-query or model query
58358     properties:
58359       secondary-filt:
58360         type: array
58361         items:
58362           $ref: "#/definitions/secondary-filt"
58363   segmentation-assignment:
58364     description: |
58365       Openstack segmentation assignment.
58366       ###### Related Nodes
58367       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58368     required:
58369     - segmentation-id
58370     properties:
58371       segmentation-id:
58372         type: string
58373         description: Route Table Reference id, UUID assigned to this instance.
58374       resource-version:
58375         type: string
58376         description: Concurrency value
58377       relationship-list:
58378         type: array
58379         items:
58380           $ref: "#/definitions/relationship"
58381   segmentation-assignments:
58382     description: |
58383       Collection of openstack segmentation assignments
58384     properties:
58385       segmentation-assignment:
58386         type: array
58387         items:
58388           $ref: "#/definitions/segmentation-assignment"
58389   service:
58390     description: |
58391       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
58392     required:
58393     - service-id
58394     - service-description
58395     properties:
58396       service-id:
58397         type: string
58398         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
58399       service-description:
58400         type: string
58401         description: Description of the service
58402       service-selflink:
58403         type: string
58404         description: URL to endpoint where AAI can get more details
58405       resource-version:
58406         type: string
58407         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58408       service-version:
58409         type: string
58410         description: service version
58411       relationship-list:
58412         type: array
58413         items:
58414           $ref: "#/definitions/relationship"
58415   service-capabilities:
58416     description: |
58417       Collection of service capabilities.
58418     properties:
58419       service-capability:
58420         type: array
58421         items:
58422           $ref: "#/definitions/service-capability"
58423   service-capability:
58424     description: |
58425       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
58426       ###### Related Nodes
58427       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
58428       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
58429       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
58430     required:
58431     - service-type
58432     - vnf-type
58433     properties:
58434       service-type:
58435         type: string
58436         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
58437       vnf-type:
58438         type: string
58439         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.
58440       resource-version:
58441         type: string
58442         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58443       relationship-list:
58444         type: array
58445         items:
58446           $ref: "#/definitions/relationship"
58447   service-design-and-creation:
58448     description: |
58449       Namespace for objects managed by ASDC
58450     properties:
58451       vnf-images:
58452         type: array
58453         items:
58454           $ref: "#/definitions/vnf-image"
58455       services:
58456         type: array
58457         items:
58458           $ref: "#/definitions/service"
58459       service-capabilities:
58460         type: array
58461         items:
58462           $ref: "#/definitions/service-capability"
58463       models:
58464         type: array
58465         items:
58466           $ref: "#/definitions/model"
58467       named-queries:
58468         type: array
58469         items:
58470           $ref: "#/definitions/named-query"
58471   service-instance:
58472     description: |
58473       Instance of a service
58474       ###### Related Nodes
58475       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
58476       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
58477       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
58478       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
58479       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58480       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
58481       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
58482       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
58483       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58484       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58485       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
58486       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
58487       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
58488       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58489       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
58490       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
58491       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
58492       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
58493       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
58494       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
58495       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
58496       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
58497       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
58498       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
58499     required:
58500     - service-instance-id
58501     - service-type
58502     - service-role
58503     - created-at
58504     - updated-at
58505     - description
58506     properties:
58507       service-instance-id:
58508         type: string
58509         description: Uniquely identifies this instance of a service
58510       service-instance-name:
58511         type: string
58512         description: This field will store a name assigned to the service-instance.
58513       service-type:
58514         type: string
58515         description: String capturing type of service.
58516       service-role:
58517         type: string
58518         description: String capturing the service role.
58519       environment-context:
58520         type: string
58521         description: This field will store the environment context assigned to the service-instance.
58522       workload-context:
58523         type: string
58524         description: This field will store the workload context assigned to the service-instance.
58525       created-at:
58526         type: string
58527         description: create time of Network Service.
58528       updated-at:
58529         type: string
58530         description: last update of Network Service.
58531       description:
58532         type: string
58533         description: short description for service-instance.
58534       model-invariant-id:
58535         type: string
58536         description: the ASDC model id for this resource or service model.
58537       model-version-id:
58538         type: string
58539         description: the ASDC model version for this resource or service model.
58540       persona-model-version:
58541         type: string
58542         description: the ASDC model version for this resource or service model.
58543       widget-model-id:
58544         type: string
58545         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58546       widget-model-version:
58547         type: string
58548         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58549       bandwidth-total:
58550         type: string
58551         description: Indicates the total bandwidth to be used for this service.
58552       bandwidth-up-wan1:
58553         type: string
58554         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
58555       bandwidth-down-wan1:
58556         type: string
58557         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
58558       bandwidth-up-wan2:
58559         type: string
58560         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
58561       bandwidth-down-wan2:
58562         type: string
58563         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
58564       vhn-portal-url:
58565         type: string
58566         description: URL customers will use to access the vHN Portal.
58567       service-instance-location-id:
58568         type: string
58569         description: An identifier that customers assign to the location where this service is being used.
58570       resource-version:
58571         type: string
58572         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58573       selflink:
58574         type: string
58575         description: Path to the controller object.
58576       orchestration-status:
58577         type: string
58578         description: Orchestration status of this service.
58579       relationship-list:
58580         type: array
58581         items:
58582           $ref: "#/definitions/relationship"
58583       metadata:
58584         type: array
58585         items:
58586           $ref: "#/definitions/metadatum"
58587       allotted-resources:
58588         type: array
58589         items:
58590           $ref: "#/definitions/allotted-resource"
58591   service-instances:
58592     description: |
58593       Collection of service instances
58594     properties:
58595       service-instance:
58596         type: array
58597         items:
58598           $ref: "#/definitions/service-instance"
58599   service-subscription:
58600     description: |
58601       Object that group service instances.
58602       ###### Related Nodes
58603       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
58604       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
58605       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
58606       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
58607     required:
58608     - service-type
58609     properties:
58610       service-type:
58611         type: string
58612         description: Value defined by orchestration to identify this service across ECOMP.
58613       temp-ub-sub-account-id:
58614         type: string
58615         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
58616       resource-version:
58617         type: string
58618         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58619       service-instances:
58620         type: array
58621         items:
58622           $ref: "#/definitions/service-instance"
58623       relationship-list:
58624         type: array
58625         items:
58626           $ref: "#/definitions/relationship"
58627   service-subscriptions:
58628     description: |
58629       Collection of objects that group service instances.
58630     properties:
58631       service-subscription:
58632         type: array
58633         items:
58634           $ref: "#/definitions/service-subscription"
58635   services:
58636     description: |
58637       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
58638     properties:
58639       service:
58640         type: array
58641         items:
58642           $ref: "#/definitions/service"
58643   site-pair:
58644     description: |
58645       ###### Related Nodes
58646       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
58647       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
58648       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
58649     required:
58650     - site-pair-id
58651     properties:
58652       site-pair-id:
58653         type: string
58654         description: unique identifier of probe
58655       source-ip:
58656         type: string
58657         description: Prefix address
58658       destination-ip:
58659         type: string
58660         description: Prefix address
58661       ip-version:
58662         type: string
58663         description: ip version, v4, v6
58664       destination-hostname:
58665         type: string
58666         description: Hostname of the destination equipment to which SLAs are measured against.
58667       destination-equip-type:
58668         type: string
58669         description: The type of destinatination equipment. Could be Router, UCPE, etc.
58670       resource-version:
58671         type: string
58672         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58673       classes-of-service:
58674         type: array
58675         items:
58676           $ref: "#/definitions/class-of-service"
58677       relationship-list:
58678         type: array
58679         items:
58680           $ref: "#/definitions/relationship"
58681   site-pair-set:
58682     description: |
58683       Set of instances for probes used to measure service level agreements
58684       ###### Related Nodes
58685       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58686       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
58687       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
58688     required:
58689     - site-pair-set-id
58690     properties:
58691       site-pair-set-id:
58692         type: string
58693         description: Unique id of site pair set.
58694       resource-version:
58695         type: string
58696         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58697       routing-instances:
58698         type: array
58699         items:
58700           $ref: "#/definitions/routing-instance"
58701       relationship-list:
58702         type: array
58703         items:
58704           $ref: "#/definitions/relationship"
58705   site-pair-sets:
58706     description: |
58707       Collection of sets of instances for probes related to generic-vnf
58708     properties:
58709       site-pair-set:
58710         type: array
58711         items:
58712           $ref: "#/definitions/site-pair-set"
58713   site-pairs:
58714     description: |
58715       probe within a set
58716     properties:
58717       site-pair:
58718         type: array
58719         items:
58720           $ref: "#/definitions/site-pair"
58721   snapshot:
58722     description: |
58723       Openstack snapshot
58724       ###### Related Nodes
58725       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58726       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
58727     required:
58728     - snapshot-id
58729     properties:
58730       snapshot-id:
58731         type: string
58732         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
58733       snapshot-name:
58734         type: string
58735         description: Snapshot name
58736       snapshot-architecture:
58737         type: string
58738         description: Operating system architecture
58739       snapshot-os-distro:
58740         type: string
58741         description: The common name of the operating system distribution in lowercase
58742       snapshot-os-version:
58743         type: string
58744         description: The operating system version as specified by the distributor.
58745       application:
58746         type: string
58747         description: The application that the image instantiates.
58748       application-vendor:
58749         type: string
58750         description: The vendor of the application.
58751       application-version:
58752         type: string
58753         description: The version of the application.
58754       snapshot-selflink:
58755         type: string
58756         description: URL to endpoint where AAI can get more details
58757       prev-snapshot-id:
58758         type: string
58759         description: This field contains the UUID of the previous snapshot (if any).
58760       resource-version:
58761         type: string
58762         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58763       relationship-list:
58764         type: array
58765         items:
58766           $ref: "#/definitions/relationship"
58767   snapshots:
58768     description: |
58769       Collection of openstack snapshots
58770     properties:
58771       snapshot:
58772         type: array
58773         items:
58774           $ref: "#/definitions/snapshot"
58775   sriov-pf:
58776     description: |
58777       SR-IOV Physical Function
58778       ###### Related Nodes
58779       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
58780       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
58781     required:
58782     - pf-pci-id
58783     properties:
58784       pf-pci-id:
58785         type: string
58786         description: Identifier for the sriov-pf
58787       resource-version:
58788         type: string
58789         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58790       relationship-list:
58791         type: array
58792         items:
58793           $ref: "#/definitions/relationship"
58794   sriov-pfs:
58795     description: |
58796       Collection of SR-IOV Physical Functions.
58797     properties:
58798       sriov-pf:
58799         type: array
58800         items:
58801           $ref: "#/definitions/sriov-pf"
58802   sriov-vf:
58803     description: |
58804       SR-IOV Virtual Function (not to be confused with virtual network function)
58805       ###### Related Nodes
58806       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
58807       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
58808     required:
58809     - pci-id
58810     properties:
58811       pci-id:
58812         type: string
58813         description: PCI ID used to identify the sriov-vf
58814       vf-vlan-filter:
58815         type: string
58816         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
58817       vf-mac-filter:
58818         type: string
58819         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
58820       vf-vlan-strip:
58821         type: boolean
58822         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
58823       vf-vlan-anti-spoof-check:
58824         type: boolean
58825         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.
58826       vf-mac-anti-spoof-check:
58827         type: boolean
58828         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.
58829       vf-mirrors:
58830         type: string
58831         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
58832       vf-broadcast-allow:
58833         type: boolean
58834         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
58835       vf-unknown-multicast-allow:
58836         type: boolean
58837         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
58838       vf-unknown-unicast-allow:
58839         type: boolean
58840         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
58841       vf-insert-stag:
58842         type: boolean
58843         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
58844       vf-link-status:
58845         type: string
58846         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
58847       resource-version:
58848         type: string
58849         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58850       neutron-network-id:
58851         type: string
58852         description: Neutron network id of the interface
58853       relationship-list:
58854         type: array
58855         items:
58856           $ref: "#/definitions/relationship"
58857   sriov-vfs:
58858     description: |
58859       Collection of SR-IOV Virtual Functions.
58860     properties:
58861       sriov-vf:
58862         type: array
58863         items:
58864           $ref: "#/definitions/sriov-vf"
58865   start-node-filter:
58866     properties:
58867       property-name:
58868         type: string
58869       property-value:
58870         type: string
58871   subnet:
58872     description: |
58873       ###### Related Nodes
58874       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58875       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
58876       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
58877       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
58878       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
58879       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
58880       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
58881       - SUBNET is DELETED when these are DELETED HOST-ROUTE
58882     required:
58883     - subnet-id
58884     - dhcp-enabled
58885     properties:
58886       subnet-id:
58887         type: string
58888         description: Subnet ID, should be UUID.
58889       subnet-name:
58890         type: string
58891         description: Name associated with the subnet.
58892       neutron-subnet-id:
58893         type: string
58894         description: Neutron id of this subnet
58895       gateway-address:
58896         type: string
58897         description: gateway ip address
58898       network-start-address:
58899         type: string
58900         description: network start address
58901       cidr-mask:
58902         type: string
58903         description: cidr mask
58904       ip-version:
58905         type: string
58906         description: ip version
58907       orchestration-status:
58908         type: string
58909         description: Orchestration status of this VNF, mastered by MSO
58910       dhcp-enabled:
58911         type: boolean
58912       dhcp-start:
58913         type: string
58914         description: the start address reserved for use by dhcp
58915       dhcp-end:
58916         type: string
58917         description: the last address reserved for use by dhcp
58918       subnet-role:
58919         type: string
58920         description: role of the subnet, referenced when assigning IPs
58921       ip-assignment-direction:
58922         type: string
58923         description: ip address assignment direction of the subnet
58924       resource-version:
58925         type: string
58926         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58927       subnet-sequence:
58928         type: integer
58929         format: int32
58930         description: sequence of the subnet
58931       host-routes:
58932         type: array
58933         items:
58934           $ref: "#/definitions/host-route"
58935       relationship-list:
58936         type: array
58937         items:
58938           $ref: "#/definitions/relationship"
58939   subnets:
58940     properties:
58941       subnet:
58942         type: array
58943         items:
58944           $ref: "#/definitions/subnet"
58945   tagged-inventory-item-list:
58946     properties:
58947       inventory-item:
58948         type: array
58949         items:
58950           $ref: "#/definitions/inventory-item"
58951   tenant:
58952     description: |
58953       Openstack tenant
58954       ###### Related Nodes
58955       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58956       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
58957       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58958       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58959       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
58960       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
58961       - TENANT cannot be deleted if linked to VSERVER
58962     required:
58963     - tenant-id
58964     - tenant-name
58965     properties:
58966       tenant-id:
58967         type: string
58968         description: Unique id relative to the cloud-region.
58969       tenant-name:
58970         type: string
58971         description: Readable name of tenant
58972       tenant-context:
58973         type: string
58974         description: This field will store the tenant context.
58975       resource-version:
58976         type: string
58977         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58978       vservers:
58979         type: array
58980         items:
58981           $ref: "#/definitions/vserver"
58982       relationship-list:
58983         type: array
58984         items:
58985           $ref: "#/definitions/relationship"
58986   tenants:
58987     description: |
58988       Collection of openstack tenants.
58989     properties:
58990       tenant:
58991         type: array
58992         items:
58993           $ref: "#/definitions/tenant"
58994   tunnel-xconnect:
58995     description: |
58996       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
58997       ###### Related Nodes
58998       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
58999     required:
59000     - id
59001     properties:
59002       id:
59003         type: string
59004         description: Allotted Resource id UUID assigned to this instance.
59005       bandwidth-up-wan1:
59006         type: string
59007         description: The WAN uplink bandwidth for WAN1
59008       bandwidth-down-wan1:
59009         type: string
59010         description: The WAN downlink bandwidth for WAN1
59011       bandwidth-up-wan2:
59012         type: string
59013         description: The WAN uplink bandwidth for WAN2
59014       bandwidth-down-wan2:
59015         type: string
59016         description: The WAN downlink bandwidth for WAN2
59017       resource-version:
59018         type: string
59019         description: Concurrency value
59020       relationship-list:
59021         type: array
59022         items:
59023           $ref: "#/definitions/relationship"
59024   tunnel-xconnects:
59025     description: |
59026       This object is used to store the specific tunnel cross connect aspects of an allotted resource
59027     properties:
59028       tunnel-xconnect:
59029         type: array
59030         items:
59031           $ref: "#/definitions/tunnel-xconnect"
59032   update:
59033     description: |
59034       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
59035     required:
59036     - update-node-type
59037     properties:
59038       update-node-type:
59039         type: string
59040       update-node-key:
59041         type: array
59042         items:
59043           $ref: "#/definitions/update-node-key"
59044       update-node-uri:
59045         type: string
59046       action:
59047         type: array
59048         items:
59049           $ref: "#/definitions/action"
59050   update-node-key:
59051     properties:
59052       key-name:
59053         type: string
59054       key-value:
59055         type: string
59056   vce:
59057     description: |
59058       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
59059       ###### Related Nodes
59060       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
59061       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
59062       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
59063       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59064       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59065       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59066       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
59067       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
59068     required:
59069     - vnf-id
59070     - vnf-name
59071     - vnf-type
59072     properties:
59073       vnf-id:
59074         type: string
59075         description: Unique id of VNF.  This is unique across the graph.
59076       vnf-name:
59077         type: string
59078         description: Name of VNF.
59079       vnf-name2:
59080         type: string
59081         description: Alternate name of VNF.
59082       vnf-type:
59083         type: string
59084         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.
59085       service-id:
59086         type: string
59087         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
59088       regional-resource-zone:
59089         type: string
59090         description: Regional way of organizing pservers, source of truth should define values
59091       prov-status:
59092         type: string
59093         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59094       operational-status:
59095         type: string
59096         description: Indicator for whether the resource is considered operational
59097       license-key:
59098         type: string
59099         description: OBSOLETE -  do not use
59100       equipment-role:
59101         type: string
59102         description: Network role being played by this VNF
59103       orchestration-status:
59104         type: string
59105         description: Orchestration status of this VNF, mastered by MSO
59106       heat-stack-id:
59107         type: string
59108         description: Heat stack id corresponding to this instance, managed by MSO
59109       mso-catalog-key:
59110         type: string
59111         description: Corresponds to the SDN-C catalog id used to configure this VCE
59112       vpe-id:
59113         type: string
59114         description: Unique ID of VPE connected to this VCE.
59115       v6-vce-wan-address:
59116         type: string
59117         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
59118       ipv4-oam-address:
59119         type: string
59120         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
59121       resource-version:
59122         type: string
59123         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59124       ipv4-loopback0-address:
59125         type: string
59126         description: Loopback0 address
59127       entitlement-resource-uuid:
59128         type: string
59129         description: OBSOLETE -  see child relationships
59130       port-groups:
59131         type: array
59132         items:
59133           $ref: "#/definitions/port-group"
59134       licenses:
59135         type: array
59136         items:
59137           $ref: "#/definitions/license"
59138       entitlements:
59139         type: array
59140         items:
59141           $ref: "#/definitions/entitlement"
59142       relationship-list:
59143         type: array
59144         items:
59145           $ref: "#/definitions/relationship"
59146   vces:
59147     description: |
59148       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
59149     properties:
59150       vce:
59151         type: array
59152         items:
59153           $ref: "#/definitions/vce"
59154   vf-module:
59155     description: |
59156       a deployment unit of VNFCs
59157       ###### Related Nodes
59158       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59159       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
59160       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
59161       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
59162       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
59163       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
59164       - VF-MODULE cannot be deleted if linked to VNFC
59165     required:
59166     - vf-module-id
59167     - is-base-vf-module
59168     properties:
59169       vf-module-id:
59170         type: string
59171         description: Unique ID of vf-module.
59172       vf-module-name:
59173         type: string
59174         description: Name of vf-module
59175       heat-stack-id:
59176         type: string
59177         description: Heat stack id corresponding to this instance.
59178       orchestration-status:
59179         type: string
59180         description: orchestration status of this vf-module, mastered by MSO
59181       is-base-vf-module:
59182         type: boolean
59183       resource-version:
59184         type: string
59185         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59186       model-invariant-id:
59187         type: string
59188         description: the ASDC model id for this resource or service model.
59189       model-version-id:
59190         type: string
59191         description: the ASDC model version for this resource or service model.
59192       persona-model-version:
59193         type: string
59194         description: the ASDC model version for this resource or service model.
59195       model-customization-id:
59196         type: string
59197         description: captures the id of all the configuration used to customize the resource for the service.
59198       widget-model-id:
59199         type: string
59200         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59201       widget-model-version:
59202         type: string
59203         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59204       contrail-service-instance-fqdn:
59205         type: string
59206         description: the Contrail unique ID for a service-instance
59207       module-index:
59208         type: integer
59209         format: int32
59210         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
59211       selflink:
59212         type: string
59213         description: Path to the controller object.
59214       relationship-list:
59215         type: array
59216         items:
59217           $ref: "#/definitions/relationship"
59218   vf-modules:
59219     description: |
59220       Collection of vf-modules, a deployment unit of VNFCs
59221     properties:
59222       vf-module:
59223         type: array
59224         items:
59225           $ref: "#/definitions/vf-module"
59226   vig-server:
59227     description: |
59228       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
59229       ###### Related Nodes
59230       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
59231     required:
59232     - vig-address-type
59233     properties:
59234       vig-address-type:
59235         type: string
59236         description: indicates whether the VIG is for AVPN or INTERNET
59237       ipaddress-v4-vig:
59238         type: string
59239         description: v4 IP of the vig server
59240       ipaddress-v6-vig:
59241         type: string
59242         description: v6 IP of the vig server
59243       resource-version:
59244         type: string
59245         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59246       relationship-list:
59247         type: array
59248         items:
59249           $ref: "#/definitions/relationship"
59250   vig-servers:
59251     properties:
59252       vig-server:
59253         type: array
59254         items:
59255           $ref: "#/definitions/vig-server"
59256   vip-ipv4-address-list:
59257     description: |
59258       IPv4 Address Range
59259       ###### Related Nodes
59260       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59261       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59262       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
59263       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
59264     required:
59265     - vip-ipv4-address
59266     properties:
59267       vip-ipv4-address:
59268         type: string
59269         description: IP address
59270       vip-ipv4-prefix-length:
59271         type: integer
59272         format: int64
59273         description: Prefix length, 32 for single address
59274       vlan-id-inner:
59275         type: integer
59276         format: int64
59277         description: Inner VLAN tag
59278       vlan-id-outer:
59279         type: integer
59280         format: int64
59281         description: Outer VLAN tag
59282       is-floating:
59283         type: boolean
59284         description: Indicator of fixed or floating address
59285       resource-version:
59286         type: string
59287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59288       neutron-network-id:
59289         type: string
59290         description: Neutron network id of the interface that address belongs to
59291       neutron-subnet-id:
59292         type: string
59293         description: Neutron id of subnet that address belongs to
59294       relationship-list:
59295         type: array
59296         items:
59297           $ref: "#/definitions/relationship"
59298   vip-ipv6-address-list:
59299     description: |
59300       IPv6 Address Range
59301       ###### Related Nodes
59302       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59303       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59304       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
59305       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
59306     required:
59307     - vip-ipv6-address
59308     properties:
59309       vip-ipv6-address:
59310         type: string
59311         description: IP address
59312       vip-ipv6-prefix-length:
59313         type: integer
59314         format: int64
59315         description: Prefix length, 128 for single address
59316       vlan-id-inner:
59317         type: integer
59318         format: int64
59319         description: Inner VLAN tag
59320       vlan-id-outer:
59321         type: integer
59322         format: int64
59323         description: Outer VLAN tag
59324       is-floating:
59325         type: boolean
59326         description: Indicator of fixed or floating address
59327       resource-version:
59328         type: string
59329         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59330       neutron-network-id:
59331         type: string
59332         description: Neutron network id of the interface that address belongs to
59333       neutron-subnet-id:
59334         type: string
59335         description: Neutron id of subnet that address belongs to
59336       relationship-list:
59337         type: array
59338         items:
59339           $ref: "#/definitions/relationship"
59340   virtual-data-center:
59341     description: |
59342       Virtual organization of cloud infrastructure elements in a data center context
59343       ###### Related Nodes
59344       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59345       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59346       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59347     required:
59348     - vdc-id
59349     - vdc-name
59350     properties:
59351       vdc-id:
59352         type: string
59353         description: Unique ID of the vdc
59354       vdc-name:
59355         type: string
59356         description: Name of the virtual data center
59357       resource-version:
59358         type: string
59359         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59360       relationship-list:
59361         type: array
59362         items:
59363           $ref: "#/definitions/relationship"
59364   virtual-data-centers:
59365     description: |
59366       Virtual organization of cloud infrastructure elements in a data center context
59367     properties:
59368       virtual-data-center:
59369         type: array
59370         items:
59371           $ref: "#/definitions/virtual-data-center"
59372   vlan:
59373     description: |
59374       Definition of vlan
59375       ###### Related Nodes
59376       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
59377       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59378       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
59379       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
59380       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
59381       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59382       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59383       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
59384       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
59385     required:
59386     - vlan-interface
59387     - in-maint
59388     - is-ip-unnumbered
59389     properties:
59390       vlan-interface:
59391         type: string
59392         description: String that identifies the interface
59393       vlan-id-inner:
59394         type: integer
59395         format: int64
59396         description: Inner VLAN tag
59397       vlan-id-outer:
59398         type: integer
59399         format: int64
59400         description: Outer VLAN tag
59401       resource-version:
59402         type: string
59403         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59404       speed-value:
59405         type: string
59406         description: Captures the numeric part of the speed
59407       speed-units:
59408         type: string
59409         description: Captures the units corresponding to the speed
59410       vlan-description:
59411         type: string
59412         description: Used to describe (the service associated with) the vlan
59413       backdoor-connection:
59414         type: string
59415         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
59416       vpn-key:
59417         type: string
59418         description: This indicates the customers VPN ID associated with this vlan
59419       orchestration-status:
59420         type: string
59421         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
59422       in-maint:
59423         type: boolean
59424       prov-status:
59425         type: string
59426         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
59427       is-ip-unnumbered:
59428         type: boolean
59429       relationship-list:
59430         type: array
59431         items:
59432           $ref: "#/definitions/relationship"
59433       l3-interface-ipv4-address-list:
59434         type: array
59435         items:
59436           $ref: "#/definitions/l3-interface-ipv4-address-list"
59437       l3-interface-ipv6-address-list:
59438         type: array
59439         items:
59440           $ref: "#/definitions/l3-interface-ipv6-address-list"
59441   vlans:
59442     properties:
59443       vlan:
59444         type: array
59445         items:
59446           $ref: "#/definitions/vlan"
59447   vnf:
59448     description: |
59449       Abstract vnf class
59450     required:
59451     - vnf-id
59452     properties:
59453       vnf-id:
59454         type: string
59455         description: Unique id of VNF.  This is unique across the graph.
59456   vnf-image:
59457     description: |
59458       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
59459       ###### Related Nodes
59460       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
59461       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
59462     required:
59463     - vnf-image-uuid
59464     - application
59465     - application-vendor
59466     properties:
59467       vnf-image-uuid:
59468         type: string
59469         description: Unique ID of this asset
59470       application:
59471         type: string
59472         description: The application that the image instantiates.
59473       application-vendor:
59474         type: string
59475         description: The vendor of the application.
59476       application-version:
59477         type: string
59478         description: The version of the application.
59479       selflink:
59480         type: string
59481         description: URL to endpoint where AAI can get more details
59482       resource-version:
59483         type: string
59484         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59485       relationship-list:
59486         type: array
59487         items:
59488           $ref: "#/definitions/relationship"
59489   vnf-images:
59490     description: |
59491       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
59492     properties:
59493       vnf-image:
59494         type: array
59495         items:
59496           $ref: "#/definitions/vnf-image"
59497   vnfc:
59498     description: |
59499       ###### Related Nodes
59500       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59501       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59502       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
59503       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
59504       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
59505       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
59506       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59507       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59508       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
59509     required:
59510     - vnfc-name
59511     - nfc-naming-code
59512     - nfc-function
59513     - in-maint
59514     - is-closed-loop-disabled
59515     properties:
59516       vnfc-name:
59517         type: string
59518         description: Unique ID of vnfc.
59519       nfc-naming-code:
59520         type: string
59521         description: Short code that is used in naming instances of the item being modeled
59522       nfc-function:
59523         type: string
59524         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
59525       prov-status:
59526         type: string
59527         description: prov status of this vnfc
59528       orchestration-status:
59529         type: string
59530         description: Orchestration status of this VNF, mastered by APP-C
59531       ipaddress-v4-oam-vip:
59532         type: string
59533         description: Oam V4 vip address of this vnfc
59534       in-maint:
59535         type: boolean
59536       is-closed-loop-disabled:
59537         type: boolean
59538       group-notation:
59539         type: string
59540         description: Group notation of VNFC
59541       model-invariant-id:
59542         type: string
59543         description: the ASDC model id for this resource or service model.
59544       model-version-id:
59545         type: string
59546         description: the ASDC model version for this resource or service model.
59547       resource-version:
59548         type: string
59549         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59550       relationship-list:
59551         type: array
59552         items:
59553           $ref: "#/definitions/relationship"
59554       l3-interface-ipv4-address-list:
59555         type: array
59556         items:
59557           $ref: "#/definitions/l3-interface-ipv4-address-list"
59558       l3-interface-ipv6-address-list:
59559         type: array
59560         items:
59561           $ref: "#/definitions/l3-interface-ipv6-address-list"
59562   vnfcs:
59563     description: |
59564       virtual network components associated with a vserver from application controller.
59565     properties:
59566       vnfc:
59567         type: array
59568         items:
59569           $ref: "#/definitions/vnfc"
59570   volume:
59571     description: |
59572       Ephemeral Block storage volume.
59573       ###### Related Nodes
59574       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
59575     required:
59576     - volume-id
59577     - volume-selflink
59578     properties:
59579       volume-id:
59580         type: string
59581         description: Unique ID of block storage volume relative to the vserver.
59582       volume-selflink:
59583         type: string
59584         description: URL to endpoint where AAI can get more details
59585       resource-version:
59586         type: string
59587         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59588       relationship-list:
59589         type: array
59590         items:
59591           $ref: "#/definitions/relationship"
59592   volume-group:
59593     description: |
59594       Persistent block-level storage.
59595       ###### Related Nodes
59596       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59597       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59598       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59599       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
59600       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59601     required:
59602     - volume-group-id
59603     - volume-group-name
59604     - vnf-type
59605     properties:
59606       volume-group-id:
59607         type: string
59608         description: Unique ID of volume-group.
59609       volume-group-name:
59610         type: string
59611         description: Name of the volume group.
59612       heat-stack-id:
59613         type: string
59614         description: Heat stack id corresponding to this volume-group
59615       vnf-type:
59616         type: string
59617         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.
59618       orchestration-status:
59619         type: string
59620         description: Orchestration status of this volume-group
59621       model-customization-id:
59622         type: string
59623         description: captures the id of all the configuration used to customize the resource for the service.
59624       vf-module-model-customization-id:
59625         type: string
59626         description: helps relate the volume group to the vf-module whose components will require the volume group
59627       resource-version:
59628         type: string
59629         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59630       relationship-list:
59631         type: array
59632         items:
59633           $ref: "#/definitions/relationship"
59634   volume-groups:
59635     description: |
59636       Collection of persistent block-level storage.
59637     properties:
59638       volume-group:
59639         type: array
59640         items:
59641           $ref: "#/definitions/volume-group"
59642   volumes:
59643     description: |
59644       Collection of ephemeral Block storage volumes.
59645     properties:
59646       volume:
59647         type: array
59648         items:
59649           $ref: "#/definitions/volume"
59650   vpls-pe:
59651     description: |
59652       VPLS Provider Edge routers.
59653       ###### Related Nodes
59654       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59655       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
59656       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59657       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59658       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
59659     required:
59660     - equipment-name
59661     properties:
59662       equipment-name:
59663         type: string
59664       prov-status:
59665         type: string
59666         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59667       ipv4-oam-address:
59668         type: string
59669         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).
59670       equipment-role:
59671         type: string
59672         description: Client should send valid enumerated value, e.g., VPLS-PE.
59673       vlan-id-outer:
59674         type: integer
59675         format: int64
59676         description: Temporary location for stag to get to VCE
59677       resource-version:
59678         type: string
59679         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59680       relationship-list:
59681         type: array
59682         items:
59683           $ref: "#/definitions/relationship"
59684       p-interfaces:
59685         type: array
59686         items:
59687           $ref: "#/definitions/p-interface"
59688       lag-interfaces:
59689         type: array
59690         items:
59691           $ref: "#/definitions/lag-interface"
59692   vpls-pes:
59693     description: |
59694       Collection of VPLS Provider Edge routers
59695     properties:
59696       vpls-pe:
59697         type: array
59698         items:
59699           $ref: "#/definitions/vpls-pe"
59700   vpn-binding:
59701     description: |
59702       VPN binding
59703       ###### Related Nodes
59704       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
59705       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59706       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59707       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
59708       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
59709       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
59710     required:
59711     - vpn-id
59712     - vpn-name
59713     properties:
59714       vpn-id:
59715         type: string
59716         description: VPN ID, globally unique within A&AI
59717       vpn-name:
59718         type: string
59719         description: VPN Name
59720       vpn-platform:
59721         type: string
59722         description: the platform associated with the VPN example AVPN, Mobility
59723       vpn-type:
59724         type: string
59725         description: Type of the vpn, should be taken from enumerated/valid values
59726       vpn-region:
59727         type: string
59728         description: region of customer vpn
59729       customer-vpn-id:
59730         type: string
59731         description: id for this customer vpn
59732       route-distinguisher:
59733         type: string
59734         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
59735       resource-version:
59736         type: string
59737         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59738       route-targets:
59739         type: array
59740         items:
59741           $ref: "#/definitions/route-target"
59742       relationship-list:
59743         type: array
59744         items:
59745           $ref: "#/definitions/relationship"
59746         description: l3-networks relate to vpn-bindings
59747   vpn-bindings:
59748     properties:
59749       vpn-binding:
59750         type: array
59751         items:
59752           $ref: "#/definitions/vpn-binding"
59753   vserver:
59754     description: |
59755       Virtual Servers, aka virtual machine or VM.
59756       ###### Related Nodes
59757       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
59758       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
59759       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
59760       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
59761       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
59762       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
59763       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
59764       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
59765       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
59766       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
59767       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
59768       - VSERVER is DELETED when these are DELETED L-INTERFACE
59769       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
59770     required:
59771     - vserver-id
59772     - vserver-name
59773     - vserver-selflink
59774     - in-maint
59775     - is-closed-loop-disabled
59776     properties:
59777       vserver-id:
59778         type: string
59779         description: Unique identifier for this vserver relative to its tenant
59780       vserver-name:
59781         type: string
59782         description: Name of vserver
59783       vserver-name2:
59784         type: string
59785         description: Alternative name of vserver
59786       prov-status:
59787         type: string
59788         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59789       vserver-selflink:
59790         type: string
59791         description: URL to endpoint where AAI can get more details
59792       in-maint:
59793         type: boolean
59794       is-closed-loop-disabled:
59795         type: boolean
59796       resource-version:
59797         type: string
59798         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59799       volumes:
59800         type: array
59801         items:
59802           $ref: "#/definitions/volume"
59803       relationship-list:
59804         type: array
59805         items:
59806           $ref: "#/definitions/relationship"
59807       l-interfaces:
59808         type: array
59809         items:
59810           $ref: "#/definitions/l-interface"
59811   vservers:
59812     description: |
59813       Collection of virtual Servers, aka virtual machines or VMs.
59814     properties:
59815       vserver:
59816         type: array
59817         items:
59818           $ref: "#/definitions/vserver"
59819   zone:
59820     description: |
59821       A zone is a grouping of assets in a location homing to the same connections into the CBB
59822       ###### Related Nodes
59823       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59824       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
59825       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
59826       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
59827       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
59828     required:
59829     - zone-id
59830     - zone-name
59831     - design-type
59832     - zone-context
59833     properties:
59834       zone-id:
59835         type: string
59836         description: Code assigned by AIC to the zone
59837       zone-name:
59838         type: string
59839         description: English name associated with the zone
59840       design-type:
59841         type: string
59842         description: Design of zone [Medium/Large…]
59843       zone-context:
59844         type: string
59845         description: Context of zone [production/test]
59846       status:
59847         type: string
59848         description: Status of a zone.
59849       resource-version:
59850         type: string
59851         description: Concurrency value
59852       relationship-list:
59853         type: array
59854         items:
59855           $ref: "#/definitions/relationship"
59856   zones:
59857     description: |
59858       Collection of zones
59859     properties:
59860       zone:
59861         type: array
59862         items:
59863           $ref: "#/definitions/zone"
59864 patchDefinitions:
59865   aai-internal:
59866     properties:
59867       property-name:
59868         type: string
59869       property-value:
59870         type: string
59871   action:
59872     properties:
59873       action-type:
59874         type: string
59875       action-data:
59876         type: array
59877         items:
59878           $ref: "#/patchDefinitions/action-data"
59879   action-data:
59880     properties:
59881       property-name:
59882         type: string
59883       property-value:
59884         type: string
59885   actions:
59886     description: |
59887       APIs that are more action related than REST (e.g., notify, update).
59888     properties:
59889       update:
59890         type: object
59891         $ref: "#/patchDefinitions/update"
59892       notify:
59893         type: object
59894         $ref: "#/patchDefinitions/notify"
59895   allotted-resource:
59896     description: |
59897       Represents a slice or partial piece of a resource that gets separately allotted
59898       ###### Related Nodes
59899       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
59900       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
59901       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59902       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
59903       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
59904       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
59905       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
59906       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
59907       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
59908       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
59909       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
59910       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
59911       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
59912       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
59913       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
59914     required:
59915     - id
59916     properties:
59917       id:
59918         type: string
59919         description: Allotted Resource id UUID assigned to this instance.
59920       description:
59921         type: string
59922         description: The descriptive information assigned to this allotted resource instance
59923       selflink:
59924         type: string
59925         description: Link back to more information in the controller
59926       model-invariant-id:
59927         type: string
59928         description: the ASDC model id for this resource or service model.
59929       model-version-id:
59930         type: string
59931         description: the ASDC model version for this resource or service model.
59932       persona-model-version:
59933         type: string
59934         description: the ASDC model version for this resource or service model.
59935   allotted-resources:
59936     description: |
59937       This object is used to store slices of services being offered
59938     properties:
59939       allotted-resource:
59940         type: array
59941         items:
59942           $ref: "#/patchDefinitions/allotted-resource"
59943   availability-zone:
59944     description: |
59945       Availability zone, a collection of compute hosts/pservers
59946       ###### Related Nodes
59947       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59948       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
59949       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59950       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
59951       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
59952       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
59953       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
59954       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
59955       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
59956     required:
59957     - availability-zone-name
59958     - hypervisor-type
59959     properties:
59960       availability-zone-name:
59961         type: string
59962         description: Name of the availability zone.  Unique across a cloud region
59963       hypervisor-type:
59964         type: string
59965         description: Type of hypervisor.  Source of truth should define valid values.
59966       operational-status:
59967         type: string
59968         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
59969   availability-zones:
59970     description: |
59971       Collection of availability zones
59972     properties:
59973       availability-zone:
59974         type: array
59975         items:
59976           $ref: "#/patchDefinitions/availability-zone"
59977   az-and-dvs-switches:
59978     properties:
59979       dvs-switches:
59980         type: object
59981         $ref: "#/patchDefinitions/dvs-switches"
59982       availability-zone:
59983         type: object
59984         $ref: "#/patchDefinitions/availability-zone"
59985   business:
59986     description: |
59987       Namespace for business related constructs
59988     properties:
59989       connectors:
59990         type: array
59991         items:
59992           $ref: "#/patchDefinitions/connector"
59993       customers:
59994         type: array
59995         items:
59996           $ref: "#/patchDefinitions/customer"
59997       lines-of-business:
59998         type: array
59999         items:
60000           $ref: "#/patchDefinitions/line-of-business"
60001       owning-entities:
60002         type: array
60003         items:
60004           $ref: "#/patchDefinitions/owning-entity"
60005       platforms:
60006         type: array
60007         items:
60008           $ref: "#/patchDefinitions/platform"
60009       projects:
60010         type: array
60011         items:
60012           $ref: "#/patchDefinitions/project"
60013   class-of-service:
60014     description: |
60015       ###### Related Nodes
60016       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
60017     required:
60018     - cos
60019     properties:
60020       cos:
60021         type: string
60022         description: unique identifier of probe
60023       probe-id:
60024         type: string
60025         description: identifier of probe
60026       probe-type:
60027         type: string
60028         description: type of probe
60029   classes-of-service:
60030     description: |
60031       class-of-service of probe
60032     properties:
60033       class-of-service:
60034         type: array
60035         items:
60036           $ref: "#/patchDefinitions/class-of-service"
60037   cloud-infrastructure:
60038     description: |
60039       Namespace for cloud infrastructure.
60040     properties:
60041       complexes:
60042         type: array
60043         items:
60044           $ref: "#/patchDefinitions/complex"
60045       cloud-regions:
60046         type: array
60047         items:
60048           $ref: "#/patchDefinitions/cloud-region"
60049       network-profiles:
60050         type: array
60051         items:
60052           $ref: "#/patchDefinitions/network-profile"
60053       pservers:
60054         type: array
60055         items:
60056           $ref: "#/patchDefinitions/pserver"
60057       virtual-data-centers:
60058         type: array
60059         items:
60060           $ref: "#/patchDefinitions/virtual-data-center"
60061       operational-environments:
60062         type: array
60063         items:
60064           $ref: "#/patchDefinitions/operational-environment"
60065   cloud-region:
60066     description: |
60067       cloud-region designates an installation of a cloud cluster or region or instantiation.
60068       ###### Related Nodes
60069       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
60070       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60071       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60072       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60073       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60074       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60075       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60076       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60077       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60078       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60079       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60080       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60081       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60082       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60083       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60084       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60085       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
60086       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
60087       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
60088       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
60089       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60090     required:
60091     - cloud-owner
60092     - cloud-region-id
60093     - sriov-automation
60094     properties:
60095       cloud-owner:
60096         type: string
60097         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
60098       cloud-region-id:
60099         type: string
60100         description: Identifier used by the vendor for the region. Second part of composite key
60101       cloud-type:
60102         type: string
60103         description: Type of the cloud (e.g., openstack)
60104       owner-defined-type:
60105         type: string
60106         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
60107       cloud-region-version:
60108         type: string
60109         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
60110       identity-url:
60111         type: string
60112         description: URL of the keystone identity service
60113       cloud-zone:
60114         type: string
60115         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
60116       complex-name:
60117         type: string
60118         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
60119       sriov-automation:
60120         type: boolean
60121       cloud-extra-info:
60122         type: string
60123         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
60124       cloud-epa-caps:
60125         type: string
60126         description: MultiVIM will discover and expose EPA capabilities.
60127   cloud-regions:
60128     properties:
60129       cloud-region:
60130         type: array
60131         items:
60132           $ref: "#/patchDefinitions/cloud-region"
60133   complex:
60134     description: |
60135       Collection of physical locations that can house cloud-regions.
60136       ###### Related Nodes
60137       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60138       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60139       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60140       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
60141       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
60142       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
60143       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60144       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60145       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
60146       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60147       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60148       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60149       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
60150       - COMPLEX is DELETED when these are DELETED CTAG-POOL
60151     required:
60152     - physical-location-id
60153     - physical-location-type
60154     - street1
60155     - city
60156     - postal-code
60157     - country
60158     - region
60159     properties:
60160       physical-location-id:
60161         type: string
60162         description: Unique identifier for physical location, e.g., CLLI
60163       data-center-code:
60164         type: string
60165         description: Data center code which can be an alternate way to identify a complex
60166       complex-name:
60167         type: string
60168         description: Gamma complex name for LCP instance.
60169       identity-url:
60170         type: string
60171         description: URL of the keystone identity service
60172   complexes:
60173     description: |
60174       Collection of physical locations that can house cloud-regions.
60175     properties:
60176       complex:
60177         type: array
60178         items:
60179           $ref: "#/patchDefinitions/complex"
60180   configuration:
60181     description: |
60182       Port Mirror Configuration.
60183       ###### Related Nodes
60184       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
60185       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60186       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
60187       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
60188       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
60189       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
60190       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
60191       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
60192       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
60193       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
60194       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
60195       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
60196       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
60197     required:
60198     - configuration-id
60199     - configuration-type
60200     - configuration-sub-type
60201     - orchestration-status
60202     - operational-status
60203     - configuration-selflink
60204     - model-customization-id
60205     properties:
60206       configuration-id:
60207         type: string
60208         description: UUID assigned to configuration.
60209       management-option:
60210         type: string
60211         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
60212       configuration-name:
60213         type: string
60214         description: Name of the configuration.
60215       configuration-type:
60216         type: string
60217         description: port-mirroring-configuration.
60218       configuration-sub-type:
60219         type: string
60220         description: vprobe, pprobe.
60221       model-invariant-id:
60222         type: string
60223         description: the ASDC model id for this resource or service model.
60224       model-version-id:
60225         type: string
60226         description: the ASDC model version for this resource or service model.
60227       orchestration-status:
60228         type: string
60229         description: Orchestration status of the configuration.
60230       operational-status:
60231         type: string
60232         description: Indicator for whether the resource is considered operational.
60233       configuration-selflink:
60234         type: string
60235         description: URL to endpoint where AAI can get more details from SDN-GC.
60236       model-customization-id:
60237         type: string
60238         description: id of  the configuration used to customize the resource
60239       tunnel-bandwidth:
60240         type: string
60241         description: DHV Site Effective Bandwidth
60242       vendor-allowed-max-bandwidth:
60243         type: string
60244         description: Velocloud Nominal Throughput - VNT
60245   configurations:
60246     description: |
60247       Collection of configurations
60248     properties:
60249       configuration:
60250         type: array
60251         items:
60252           $ref: "#/patchDefinitions/configuration"
60253   connector:
60254     description: |
60255       Collection of resource instances used to connect a variety of disparate inventory widgets
60256       ###### Related Nodes
60257       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
60258       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
60259       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
60260       - CONNECTOR is DELETED when these are DELETED METADATUM
60261     required:
60262     - resource-instance-id
60263     properties:
60264       resource-instance-id:
60265         type: string
60266         description: Unique id of resource instance.
60267   connectors:
60268     description: |
60269       Collection of resource instances used to connect a variety of disparate inventory widgets
60270     properties:
60271       connector:
60272         type: array
60273         items:
60274           $ref: "#/patchDefinitions/connector"
60275   constrained-element-set:
60276     description: |
60277       This is how we would capture constraints defining allowed sets of elements.
60278       ###### Related Nodes
60279       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
60280       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60281       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
60282       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
60283     required:
60284     - constrained-element-set-uuid
60285     - constraint-type
60286     - check-type
60287     properties:
60288       constrained-element-set-uuid:
60289         type: string
60290       constraint-type:
60291         type: string
60292       check-type:
60293         type: string
60294   constrained-element-sets:
60295     properties:
60296       constrained-element-set:
60297         type: array
60298         items:
60299           $ref: "#/patchDefinitions/constrained-element-set"
60300   ctag-assignment:
60301     description: |
60302       ###### Related Nodes
60303       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60304       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
60305     required:
60306     - vlan-id-inner
60307     properties:
60308       vlan-id-inner:
60309         type: integer
60310         format: int64
60311         description: id.
60312   ctag-assignments:
60313     properties:
60314       ctag-assignment:
60315         type: array
60316         items:
60317           $ref: "#/patchDefinitions/ctag-assignment"
60318   ctag-pool:
60319     description: |
60320       A collection of C tags (vlan tags) grouped for a specific purpose.
60321       ###### Related Nodes
60322       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
60323       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
60324       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
60325       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
60326     required:
60327     - target-pe
60328     - availability-zone-name
60329     - ctag-pool-purpose
60330     properties:
60331       target-pe:
60332         type: string
60333         description: The Target provider edge router
60334       availability-zone-name:
60335         type: string
60336         description: Name of the availability zone
60337       ctag-pool-purpose:
60338         type: string
60339         description: Describes what the intended purpose of this pool is.
60340       ctag-values:
60341         type: string
60342         description: Comma separated list of ctags
60343   ctag-pools:
60344     properties:
60345       ctag-pool:
60346         type: array
60347         items:
60348           $ref: "#/patchDefinitions/ctag-pool"
60349   customer:
60350     description: |
60351       customer identifiers to provide linkage back to BSS information.
60352       ###### Related Nodes
60353       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
60354       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
60355     required:
60356     - global-customer-id
60357     - subscriber-name
60358     - subscriber-type
60359     properties:
60360       global-customer-id:
60361         type: string
60362         description: Global customer id used across ECOMP to uniquely identify customer.
60363       subscriber-name:
60364         type: string
60365         description: Subscriber name, an alternate way to retrieve a customer.
60366       subscriber-type:
60367         type: string
60368         description: Subscriber type, a way to provide VID with only the INFRA customers.
60369   customers:
60370     description: |
60371       Collection of customer identifiers to provide linkage back to BSS information.
60372     properties:
60373       customer:
60374         type: array
60375         items:
60376           $ref: "#/patchDefinitions/customer"
60377   cvlan-tag-entry:
60378     required:
60379     - cvlan-tag
60380     properties:
60381       cvlan-tag:
60382         type: integer
60383         format: int64
60384         description: See mis-na-virtualization-platform.yang
60385   cvlan-tags:
60386     properties:
60387       cvlan-tag-entry:
60388         type: array
60389         items:
60390           $ref: "#/patchDefinitions/cvlan-tag-entry"
60391   dvs-switch:
60392     description: |
60393       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.
60394       ###### Related Nodes
60395       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60396       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
60397     required:
60398     - switch-name
60399     - vcenter-url
60400     properties:
60401       switch-name:
60402         type: string
60403         description: DVS switch name
60404       vcenter-url:
60405         type: string
60406         description: URL used to reach the vcenter
60407   dvs-switches:
60408     description: |
60409       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
60410     properties:
60411       dvs-switch:
60412         type: array
60413         items:
60414           $ref: "#/patchDefinitions/dvs-switch"
60415   edge-prop-names:
60416     description: |
60417       Internal map to define the properties of an edge and interpret the map EdgeRules
60418     properties:
60419       edgeLabel:
60420         type: string
60421       direction:
60422         type: string
60423       multiplicityRule:
60424         type: string
60425       contains-other-v:
60426         type: string
60427       delete-other-v:
60428         type: string
60429       SVC-INFRA:
60430         type: string
60431       prevent-delete:
60432         type: string
60433       aai-uuid:
60434         type: string
60435   edge-tag-query-request:
60436     properties:
60437       edge-tag:
60438         type: string
60439       result-detail:
60440         type: string
60441       start-node-type:
60442         type: string
60443       start-node-filter:
60444         type: array
60445         items:
60446           $ref: "#/patchDefinitions/start-node-filter"
60447       include-node-filter:
60448         type: array
60449         items:
60450           $ref: "#/patchDefinitions/include-node-filter"
60451       secondary-filter:
60452         type: array
60453         items:
60454           $ref: "#/patchDefinitions/secondary-filter"
60455   edge-tag-query-result:
60456     properties:
60457       tagged-inventory-item-list:
60458         type: array
60459         items:
60460           $ref: "#/patchDefinitions/tagged-inventory-item-list"
60461   element-choice-set:
60462     description: |
60463       This is how we would capture constraints defining allowed sets of elements.
60464       ###### Related Nodes
60465       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
60466       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
60467       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
60468     required:
60469     - element-choice-set-uuid
60470     - element-choice-set-name
60471     properties:
60472       element-choice-set-uuid:
60473         type: string
60474       element-choice-set-name:
60475         type: string
60476       cardinality:
60477         type: string
60478   element-choice-sets:
60479     properties:
60480       element-choice-set:
60481         type: array
60482         items:
60483           $ref: "#/patchDefinitions/element-choice-set"
60484   entitlement:
60485     description: |
60486       Metadata for entitlement group.
60487       ###### Related Nodes
60488       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60489       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60490     required:
60491     - group-uuid
60492     - resource-uuid
60493     properties:
60494       group-uuid:
60495         type: string
60496         description: Unique ID for the entitlement group the resource comes from, should be uuid.
60497       resource-uuid:
60498         type: string
60499         description: Unique ID of an entitlement resource.
60500   entitlements:
60501     description: |
60502       Entitlements, keyed by group-uuid and resource-uuid, related to license management
60503     properties:
60504       entitlement:
60505         type: array
60506         items:
60507           $ref: "#/patchDefinitions/entitlement"
60508   esr-ems:
60509     description: |
60510       Persist EMS address information used by EMS driver.
60511       ###### Related Nodes
60512       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
60513       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60514     required:
60515     - ems-id
60516     properties:
60517       ems-id:
60518         type: string
60519         description: Unique ID of EMS.
60520   esr-ems-list:
60521     properties:
60522       esr-ems:
60523         type: array
60524         items:
60525           $ref: "#/patchDefinitions/esr-ems"
60526   esr-system-info:
60527     description: |
60528       Persist common address information of external systems.
60529       ###### Related Nodes
60530       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
60531       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
60532       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
60533       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
60534     required:
60535     - esr-system-info-id
60536     - user-name
60537     - password
60538     - system-type
60539     properties:
60540       esr-system-info-id:
60541         type: string
60542         description: Unique ID of esr system info.
60543       system-name:
60544         type: string
60545         description: name of external system.
60546       type:
60547         type: string
60548         description: type of external systems.
60549       vendor:
60550         type: string
60551         description: vendor of external systems.
60552       version:
60553         type: string
60554         description: version of external systems.
60555       service-url:
60556         type: string
60557         description: url used to access external systems.
60558       user-name:
60559         type: string
60560         description: username used to access external systems.
60561       password:
60562         type: string
60563         description: password used to access external systems.
60564       system-type:
60565         type: string
60566         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
60567       protocol:
60568         type: string
60569         description: protocol of third party SDNC, for example netconf/snmp.
60570       ssl-cacert:
60571         type: string
60572         description: ca file content if enabled ssl on auth-url.
60573       ssl-insecure:
60574         type: boolean
60575         description: Whether to verify VIM's certificate.
60576       ip-address:
60577         type: string
60578         description: service IP of ftp server.
60579       port:
60580         type: string
60581         description: service port of ftp server.
60582       cloud-domain:
60583         type: string
60584         description: domain info for authentication.
60585       default-tenant:
60586         type: string
60587         description: default tenant of VIM.
60588       passive:
60589         type: boolean
60590         description: ftp passive mode or not.
60591       remote-path:
60592         type: string
60593         description: resource or performance data file path.
60594       system-status:
60595         type: string
60596         description: the status of external system.
60597   esr-system-info-list:
60598     description: |
60599       Collection of persistent block-level external system auth info.
60600     properties:
60601       esr-system-info:
60602         type: array
60603         items:
60604           $ref: "#/patchDefinitions/esr-system-info"
60605   esr-thirdparty-sdnc:
60606     description: |
60607       Persist SDNC address information used by ONAP SDNC.
60608       ###### Related Nodes
60609       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
60610       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
60611       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60612     required:
60613     - thirdparty-sdnc-id
60614     properties:
60615       thirdparty-sdnc-id:
60616         type: string
60617         description: Unique ID of SDNC.
60618       location:
60619         type: string
60620         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
60621       product-name:
60622         type: string
60623         description: password used to access SDNC server.
60624   esr-thirdparty-sdnc-list:
60625     properties:
60626       esr-thirdparty-sdnc:
60627         type: array
60628         items:
60629           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
60630   esr-vnfm:
60631     description: |
60632       Persist VNFM address information used by VF-C.
60633       ###### Related Nodes
60634       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
60635       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
60636     required:
60637     - vnfm-id
60638     properties:
60639       vnfm-id:
60640         type: string
60641         description: Unique ID of VNFM.
60642       vim-id:
60643         type: string
60644         description: indecate the VIM to deploy VNF.
60645       certificate-url:
60646         type: string
60647         description: certificate url of VNFM.
60648   esr-vnfm-list:
60649     properties:
60650       esr-vnfm:
60651         type: array
60652         items:
60653           $ref: "#/patchDefinitions/esr-vnfm"
60654   evc:
60655     description: |
60656       evc object is an optional child object of the Configuration object.
60657       ###### Related Nodes
60658       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
60659     required:
60660     - evc-id
60661     properties:
60662       evc-id:
60663         type: string
60664         description: Unique/key field for the evc object
60665       forwarding-path-topology:
60666         type: string
60667         description: Point-to-Point, Multi-Point
60668       cir-value:
60669         type: string
60670         description: Commited Information Rate
60671       cir-units:
60672         type: string
60673         description: CIR units
60674       connection-diversity-group-id:
60675         type: string
60676         description: Diversity Group ID
60677       service-hours:
60678         type: string
60679         description: formerly Performance Group
60680       esp-evc-circuit-id:
60681         type: string
60682         description: EVC Circuit ID of ESP EVC
60683       esp-evc-cir-value:
60684         type: string
60685         description: Committed Information Rate (For ESP)
60686       esp-evc-cir-units:
60687         type: string
60688         description: CIR units (For ESP)
60689       esp-itu-code:
60690         type: string
60691         description: Identifies ESP
60692       collector-pop-clli:
60693         type: string
60694         description: Collector POP CLLI (from the hostname of the access pnf)
60695       inter-connect-type-ingress:
60696         type: string
60697         description: Interconnect type on ingress side of EVC.
60698       tagmode-access-ingress:
60699         type: string
60700         description: tagode for collector side of EVC
60701       tagmode-access-egress:
60702         type: string
60703         description: tagMode for network side of EVC
60704   evcs:
60705     properties:
60706       evc:
60707         type: array
60708         items:
60709           $ref: "#/patchDefinitions/evc"
60710   external-system:
60711     description: |
60712       Namespace for external system.
60713     properties:
60714       esr-ems-list:
60715         type: object
60716         $ref: "#/patchDefinitions/esr-ems-list"
60717       esr-vnfm-list:
60718         type: object
60719         $ref: "#/patchDefinitions/esr-vnfm-list"
60720       esr-thirdparty-sdnc-list:
60721         type: object
60722         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
60723   extra-properties:
60724     description: |
60725       Extra properties for inventory item for response list
60726     properties:
60727       extra-property:
60728         type: array
60729         items:
60730           $ref: "#/patchDefinitions/extra-property"
60731   extra-property:
60732     properties:
60733       property-name:
60734         type: string
60735       property-value:
60736         type: string
60737   flavor:
60738     description: |
60739       Openstack flavor.
60740       ###### Related Nodes
60741       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60742       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
60743       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
60744       - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
60745     required:
60746     - flavor-id
60747     - flavor-name
60748     - flavor-selflink
60749     properties:
60750       flavor-id:
60751         type: string
60752         description: Flavor id, expected to be unique across cloud-region.
60753       flavor-name:
60754         type: string
60755         description: Cloud Region Flavor name
60756       flavor-vcpus:
60757         type: integer
60758         format: int32
60759         description: Number of CPUs
60760       flavor-ram:
60761         type: integer
60762         format: int32
60763         description: Amount of memory
60764       flavor-disk:
60765         type: integer
60766         format: int32
60767         description: Disk space
60768       flavor-ephemeral:
60769         type: integer
60770         format: int32
60771         description: Amount of ephemeral disk space
60772       flavor-swap:
60773         type: string
60774         description: amount of swap space allocation
60775       flavor-is-public:
60776         type: boolean
60777         description: whether flavor is available to all users or private to the tenant it was created in.
60778       flavor-selflink:
60779         type: string
60780         description: URL to endpoint where AAI can get more details
60781       flavor-disabled:
60782         type: boolean
60783         description: Boolean as to whether this flavor is no longer enabled
60784       hpa-capabilities:
60785         type: array
60786         items:
60787           $ref: "#/patchDefinitions/hpa-capability"
60788         description: List of flavor specific HPA Capabilities
60789   flavors:
60790     description: |
60791       Collection of openstack flavors.
60792     properties:
60793       flavor:
60794         type: array
60795         items:
60796           $ref: "#/patchDefinitions/flavor"
60797   forwarder:
60798     description: |
60799       Entity describing a sequenced segment of forwarding path
60800       ###### Related Nodes
60801       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
60802       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
60803       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
60804       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
60805       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
60806       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
60807     required:
60808     - sequence
60809     properties:
60810       sequence:
60811         type: integer
60812         format: int32
60813         description: Unique ID of this segmentation
60814       forwarder-role:
60815         type: string
60816         description: ingress, intermediate, egress
60817   forwarder-evc:
60818     description: |
60819       forwarder object is an optional child object of the Configuration object.
60820       ###### Related Nodes
60821       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
60822     required:
60823     - forwarder-evc-id
60824     properties:
60825       forwarder-evc-id:
60826         type: string
60827         description: Key for forwarder-evc object
60828       circuit-id:
60829         type: string
60830         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
60831       ivlan:
60832         type: string
60833         description: Internal VLAN.
60834       svlan:
60835         type: string
60836         description: SVLAN value for ingress of egress forwarder.
60837       cvlan:
60838         type: string
60839         description: CVLAN value for ingress of egress forwarder.
60840   forwarder-evcs:
60841     properties:
60842       forwarder-evc:
60843         type: array
60844         items:
60845           $ref: "#/patchDefinitions/forwarder-evc"
60846   forwarders:
60847     properties:
60848       forwarder:
60849         type: array
60850         items:
60851           $ref: "#/patchDefinitions/forwarder"
60852   forwarding-path:
60853     description: |
60854       Entity that describes the sequenced forwarding path between interfaces of services or resources
60855       ###### Related Nodes
60856       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
60857       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
60858       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
60859       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
60860       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
60861     required:
60862     - forwarding-path-id
60863     - forwarding-path-name
60864     properties:
60865       forwarding-path-id:
60866         type: string
60867         description: Unique ID of this FP
60868       forwarding-path-name:
60869         type: string
60870         description: Name of the FP
60871   forwarding-paths:
60872     properties:
60873       forwarding-path:
60874         type: array
60875         items:
60876           $ref: "#/patchDefinitions/forwarding-path"
60877   generic-vnf:
60878     description: |
60879       General purpose VNF
60880       ###### Related Nodes
60881       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
60882       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
60883       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
60884       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
60885       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60886       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
60887       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
60888       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
60889       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
60890       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
60891       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
60892       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
60893       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
60894       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
60895       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
60896       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
60897       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60898       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60899       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60900       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60901       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60902       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60903       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
60904       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60905       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60906       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60907       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
60908       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60909       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
60910       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
60911     required:
60912     - vnf-id
60913     - vnf-instance-id
60914     - vnf-name
60915     - vnf-type
60916     - vnf-package-name
60917     - vnf-discriptor-name
60918     - job-id
60919     - in-maint
60920     - is-closed-loop-disabled
60921     properties:
60922       vnf-id:
60923         type: string
60924         description: Unique id of VNF.  This is unique across the graph.
60925       vnf-instance-id:
60926         type: string
60927         description: vnf instance id.
60928       vnf-name:
60929         type: string
60930         description: Name of VNF.
60931       vnf-name2:
60932         type: string
60933         description: Alternate name of VNF.
60934       vnf-type:
60935         type: string
60936         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.
60937       service-id:
60938         type: string
60939         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
60940       regional-resource-zone:
60941         type: string
60942         description: Regional way of organizing pservers, source of truth should define values
60943       prov-status:
60944         type: string
60945         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60946       operational-status:
60947         type: string
60948         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
60949       license-key:
60950         type: string
60951         description: OBSOLETE -  do not use
60952       equipment-role:
60953         type: string
60954         description: Client should send valid enumerated value
60955       orchestration-status:
60956         type: string
60957         description: Orchestration status of this VNF, used by MSO.
60958       vnf-package-name:
60959         type: string
60960       vnf-discriptor-name:
60961         type: string
60962         description: vnf discriptor name
60963       job-id:
60964         type: string
60965         description: job id corresponding to vnf
60966       heat-stack-id:
60967         type: string
60968         description: Heat stack id corresponding to this instance, managed by MSO
60969       mso-catalog-key:
60970         type: string
60971         description: Corresponds to the SDN-C catalog id used to configure this VCE
60972       management-option:
60973         type: string
60974         description: identifier of managed by ATT or customer
60975       ipv4-oam-address:
60976         type: string
60977         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
60978       ipv4-loopback0-address:
60979         type: string
60980         description: v4 Loopback0 address
60981       nm-lan-v6-address:
60982         type: string
60983         description: v6 Loopback address
60984       management-v6-address:
60985         type: string
60986         description: v6 management address
60987       vcpu:
60988         type: integer
60989         format: int64
60990         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
60991       vcpu-units:
60992         type: string
60993         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
60994       vmemory:
60995         type: integer
60996         format: int64
60997         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
60998       vmemory-units:
60999         type: string
61000         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
61001       vdisk:
61002         type: integer
61003         format: int64
61004         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
61005       vdisk-units:
61006         type: string
61007         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
61008       nshd:
61009         type: integer
61010         format: int64
61011         description: number of associated SHD in vnf.
61012       nvm:
61013         type: integer
61014         format: int64
61015         description: number of vms in vnf.
61016       nnet:
61017         type: integer
61018         format: int64
61019         description: number of network in vnf.
61020       in-maint:
61021         type: boolean
61022       is-closed-loop-disabled:
61023         type: boolean
61024   generic-vnfs:
61025     description: |
61026       Collection of VNFs
61027     properties:
61028       generic-vnf:
61029         type: array
61030         items:
61031           $ref: "#/patchDefinitions/generic-vnf"
61032   group-assignment:
61033     description: |
61034       Openstack group-assignment used to store exclusivity groups (EG).
61035       ###### Related Nodes
61036       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61037       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
61038       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
61039     required:
61040     - group-id
61041     - group-type
61042     - group-name
61043     properties:
61044       group-id:
61045         type: string
61046         description: Group id, expected to be unique across cloud-region.
61047       group-type:
61048         type: string
61049         description: Group type - the type of group this instance refers to
61050       group-name:
61051         type: string
61052         description: Group name - name assigned to the group
61053       group-description:
61054         type: string
61055         description: Group description - description of the group
61056   group-assignments:
61057     description: |
61058       Collection of openstack group assignments
61059     properties:
61060       group-assignment:
61061         type: array
61062         items:
61063           $ref: "#/patchDefinitions/group-assignment"
61064   host-route:
61065     description: |
61066       ###### Related Nodes
61067       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
61068     required:
61069     - host-route-id
61070     - route-prefix
61071     - next-hop
61072     properties:
61073       host-route-id:
61074         type: string
61075         description: host-route id
61076       route-prefix:
61077         type: string
61078         description: subnet prefix
61079       next-hop:
61080         type: string
61081         description: Could be ip-address, hostname, or service-instance
61082       next-hop-type:
61083         type: string
61084         description: Should be ip-address, hostname, or service-instance to match next-hop
61085   host-routes:
61086     properties:
61087       host-route:
61088         type: array
61089         items:
61090           $ref: "#/patchDefinitions/host-route"
61091   hpa-capabilities:
61092     description: |
61093       Collection of HPA Capabilities
61094     properties:
61095       hpa-capability:
61096         type: array
61097         items:
61098           $ref: "#/patchDefinitions/hpa-capability"
61099   hpa-capability:
61100     description: |
61101       Represents a HPA capability
61102       ###### Related Nodes
61103       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
61104       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61105       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
61106       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
61107     required:
61108     - hpa-capability-id
61109     - hpa-feature
61110     properties:
61111       hpa-capability-id:
61112         type: string
61113         description: UUID to uniquely identify a HPA capability
61114       hpa-feature:
61115         type: string
61116         description: Name of the HPACapability
61117       hpa-version:
61118         type: string
61119         description: HPA schema version
61120       hpa-hw-arch:
61121         type: string
61122         description: Hardware architecture
61123   hpa-feature-attributes:
61124     description: |
61125       HPA Capability Feature attributes
61126       ###### Related Nodes
61127       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
61128     properties:
61129       hpa-attr-key:
61130         type: string
61131         description: name of the specific HPA attribute
61132       hpa-attr-value:
61133         type: string
61134         description: JSON string specifying the value, unit and type of the specific HPA attribute
61135   image:
61136     description: |
61137       Openstack image.
61138       ###### Related Nodes
61139       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61140       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
61141       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
61142       - IMAGE cannot be deleted if linked to VSERVER
61143       - IMAGE is DELETED when these are DELETED METADATUM
61144     required:
61145     - image-id
61146     - image-name
61147     - image-os-distro
61148     - image-os-version
61149     - image-selflink
61150     properties:
61151       image-id:
61152         type: string
61153         description: Image id, expected to be unique across cloud region
61154       image-name:
61155         type: string
61156         description: Image name
61157       image-architecture:
61158         type: string
61159         description: Operating system architecture.
61160       image-os-distro:
61161         type: string
61162         description: The common name of the operating system distribution in lowercase
61163       image-os-version:
61164         type: string
61165         description: The operating system version as specified by the distributor.
61166       application:
61167         type: string
61168         description: The application that the image instantiates.
61169       application-vendor:
61170         type: string
61171         description: The vendor of the application.
61172       application-version:
61173         type: string
61174         description: The version of the application.
61175       image-selflink:
61176         type: string
61177         description: URL to endpoint where AAI can get more details
61178   images:
61179     description: |
61180       Collectio of Openstack images.
61181     properties:
61182       image:
61183         type: array
61184         items:
61185           $ref: "#/patchDefinitions/image"
61186   include-node-filter:
61187     properties:
61188       include-node-type:
61189         type: string
61190   instance-filter:
61191     description: |
61192       InstanceFilter for performing a named-query or model query
61193   instance-filters:
61194     description: |
61195       InstanceFilters for performing a named-query or model query
61196     properties:
61197       instance-filter:
61198         type: array
61199         items:
61200           $ref: "#/patchDefinitions/instance-filter"
61201   instance-group:
61202     description: |
61203       General mechanism for grouping instances
61204       ###### Related Nodes
61205       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
61206       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61207       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61208       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61209       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61210       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61211       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61212       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61213       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61214       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61215       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61216       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61217     required:
61218     - instance-group-role
61219     - model-invariant-id
61220     - model-version-id
61221     - id
61222     - description
61223     - type
61224     properties:
61225       instance-group-role:
61226         type: string
61227         description: role of the instance group.
61228       model-invariant-id:
61229         type: string
61230         description: ASDC model id for this resource or service model.
61231       model-version-id:
61232         type: string
61233         description: ASDC model version uid for this resource model.
61234       id:
61235         type: string
61236         description: Instance Group ID, UUID assigned to this instance.
61237       description:
61238         type: string
61239         description: Descriptive text to help identify the usage of this instance-group
61240       type:
61241         type: string
61242         description: Only valid value today is lower case ha for high availability
61243       sub-type:
61244         type: string
61245         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
61246   instance-groups:
61247     description: |
61248       Collection of openstack route table references
61249     properties:
61250       instance-group:
61251         type: array
61252         items:
61253           $ref: "#/patchDefinitions/instance-group"
61254   inventory:
61255     properties:
61256       search:
61257         type: object
61258         $ref: "#/patchDefinitions/search"
61259       actions:
61260         type: object
61261         $ref: "#/patchDefinitions/actions"
61262       cloud-infrastructure:
61263         type: object
61264         $ref: "#/patchDefinitions/cloud-infrastructure"
61265       external-system:
61266         type: object
61267         $ref: "#/patchDefinitions/external-system"
61268       business:
61269         type: object
61270         $ref: "#/patchDefinitions/business"
61271       service-design-and-creation:
61272         type: object
61273         $ref: "#/patchDefinitions/service-design-and-creation"
61274       network:
61275         type: object
61276         $ref: "#/patchDefinitions/network"
61277       aai-internal:
61278         type: object
61279         $ref: "#/patchDefinitions/aai-internal"
61280       nodes:
61281         type: array
61282         items:
61283           $ref: "#/patchDefinitions/aai-internal"
61284   inventory-item:
61285     properties:
61286       inventory-item-type:
61287         type: string
61288       inventory-item-link:
61289         type: string
61290       inventory-item-data:
61291         type: array
61292         items:
61293           $ref: "#/patchDefinitions/inventory-item-data"
61294       tagged-inventory-item-list:
61295         type: array
61296         items:
61297           $ref: "#/patchDefinitions/tagged-inventory-item-list"
61298   inventory-item-data:
61299     properties:
61300       property-name:
61301         type: string
61302       property-value:
61303         type: string
61304   inventory-response-item:
61305     description: |
61306       Inventory item for response list
61307     properties:
61308       model-name:
61309         type: string
61310       extra-properties:
61311         type: object
61312         $ref: "#/patchDefinitions/extra-properties"
61313       inventory-response-items:
61314         type: object
61315         $ref: "#/patchDefinitions/inventory-response-items"
61316   inventory-response-items:
61317     description: |
61318       Container for inventory items in response list
61319     properties:
61320       inventory-response-item:
61321         type: array
61322         items:
61323           $ref: "#/patchDefinitions/inventory-response-item"
61324   ipsec-configuration:
61325     description: |
61326       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
61327       ###### Related Nodes
61328       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
61329       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
61330       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
61331     required:
61332     - ipsec-configuration-id
61333     properties:
61334       ipsec-configuration-id:
61335         type: string
61336         description: UUID of this configuration
61337       requested-vig-address-type:
61338         type: string
61339         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
61340       requested-encryption-strength:
61341         type: string
61342         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
61343       requested-dmz-type:
61344         type: string
61345         description: ATT can offer a shared DMZ or a DMZ specific to a customer
61346       shared-dmz-network-address:
61347         type: string
61348         description: Network address of shared DMZ
61349       requested-customer-name:
61350         type: string
61351         description: If the DMZ is a custom DMZ, this field will indicate the customer information
61352       ike-version:
61353         type: string
61354         description: can be 1 or 2
61355       ikev1-authentication:
61356         type: string
61357         description: Contains values like md5, sha1, sha256, sha384
61358       ikev1-encryption:
61359         type: string
61360         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
61361       ikev1-dh-group:
61362         type: string
61363         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
61364       ikev1-am-group-id:
61365         type: string
61366         description: Group name defined in VIG for clients using aggressive mode
61367       ikev1-am-password:
61368         type: string
61369         description: pre-shared key for the above group name
61370       ikev1-sa-lifetime:
61371         type: string
61372         description: Lifetime for IKEv1 SA
61373       ipsec-authentication:
61374         type: string
61375         description: md5, sha1, sha256, sha384
61376       ipsec-encryption:
61377         type: string
61378         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
61379       ipsec-sa-lifetime:
61380         type: string
61381         description: Life time for IPSec SA
61382       ipsec-pfs:
61383         type: string
61384         description: enable PFS or not
61385       xauth-userid:
61386         type: string
61387         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
61388       xauth-user-password:
61389         type: string
61390         description: Encrypted using the Juniper $9$ algorithm
61391       dpd-interval:
61392         type: string
61393         description: The time between DPD probe
61394       dpd-frequency:
61395         type: string
61396         description: Maximum number of DPD before claiming the tunnel is down
61397   ipsec-configurations:
61398     properties:
61399       ipsec-configuration:
61400         type: array
61401         items:
61402           $ref: "#/patchDefinitions/ipsec-configuration"
61403   key-data:
61404     properties:
61405       key-name:
61406         type: string
61407       key-value:
61408         type: string
61409   l-interface:
61410     description: |
61411       Logical interfaces, e.g., a vnic.
61412       ###### Related Nodes
61413       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61414       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
61415       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61416       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61417       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
61418       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
61419       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
61420       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
61421       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
61422       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61423       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61424       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
61425       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
61426       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
61427       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
61428       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
61429       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
61430       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61431       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
61432       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61433     required:
61434     - interface-name
61435     - is-port-mirrored
61436     - in-maint
61437     - is-ip-unnumbered
61438     properties:
61439       interface-name:
61440         type: string
61441         description: Name given to the interface
61442       interface-role:
61443         type: string
61444         description: E.g., CUSTOMER, UPLINK, etc.
61445       v6-wan-link-ip:
61446         type: string
61447         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
61448       selflink:
61449         type: string
61450         description: URL to endpoint where AAI can get more details
61451       interface-id:
61452         type: string
61453         description: ID of interface
61454       macaddr:
61455         type: string
61456         description: MAC address for the interface
61457       network-name:
61458         type: string
61459         description: Name of the network
61460       management-option:
61461         type: string
61462         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
61463       interface-description:
61464         type: string
61465         description: Human friendly text regarding this interface.
61466       is-port-mirrored:
61467         type: boolean
61468   l-interfaces:
61469     description: |
61470       Collection of logical interfaces.
61471     properties:
61472       l-interface:
61473         type: array
61474         items:
61475           $ref: "#/patchDefinitions/l-interface"
61476   l3-interface-ipv4-address-list:
61477     description: |
61478       IPv4 Address Range
61479       ###### Related Nodes
61480       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61481       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61482       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61483       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61484       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61485       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61486     required:
61487     - l3-interface-ipv4-address
61488     properties:
61489       l3-interface-ipv4-address:
61490         type: string
61491         description: IP address
61492       l3-interface-ipv4-prefix-length:
61493         type: integer
61494         format: int64
61495         description: Prefix length, 32 for single address
61496       vlan-id-inner:
61497         type: integer
61498         format: int64
61499         description: Inner VLAN tag
61500       vlan-id-outer:
61501         type: integer
61502         format: int64
61503         description: Outer VLAN tag
61504       is-floating:
61505         type: boolean
61506         description: Indicator of fixed or floating address
61507   l3-interface-ipv6-address-list:
61508     description: |
61509       IPv6 Address Range
61510       ###### Related Nodes
61511       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
61512       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61513       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61514       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
61515       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61516       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61517     required:
61518     - l3-interface-ipv6-address
61519     properties:
61520       l3-interface-ipv6-address:
61521         type: string
61522         description: IP address
61523       l3-interface-ipv6-prefix-length:
61524         type: integer
61525         format: int64
61526         description: Prefix length, 128 for single address
61527       vlan-id-inner:
61528         type: integer
61529         format: int64
61530         description: Inner VLAN tag
61531       vlan-id-outer:
61532         type: integer
61533         format: int64
61534         description: Outer VLAN tag
61535       is-floating:
61536         type: boolean
61537         description: Indicator of fixed or floating address
61538   l3-network:
61539     description: |
61540       Generic network definition
61541       ###### Related Nodes
61542       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61543       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
61544       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
61545       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61546       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
61547       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
61548       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61549       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61550       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61551       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61552       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
61553       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61554       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61555       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
61556       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61557       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61558       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
61559       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
61560     required:
61561     - network-id
61562     - network-name
61563     - is-bound-to-vpn
61564     - is-provider-network
61565     - is-shared-network
61566     - is-external-network
61567     properties:
61568       network-id:
61569         type: string
61570         description: Network ID, should be uuid. Unique across A&AI.
61571       network-name:
61572         type: string
61573         description: Name of the network, governed by some naming convention..
61574       network-type:
61575         type: string
61576         description: Type of the network - who defines these values?
61577       network-role:
61578         type: string
61579         description: Role the network plans - who defines these values?
61580       network-technology:
61581         type: string
61582         description: Network technology - who defines these values?
61583       neutron-network-id:
61584         type: string
61585         description: Neutron network id of this Interface
61586       is-bound-to-vpn:
61587         type: boolean
61588       service-id:
61589         type: string
61590         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
61591       network-role-instance:
61592         type: integer
61593         format: int64
61594         description: network role instance
61595   l3-networks:
61596     properties:
61597       l3-network:
61598         type: array
61599         items:
61600           $ref: "#/patchDefinitions/l3-network"
61601   lag-interface:
61602     description: |
61603       Link aggregate interface
61604       ###### Related Nodes
61605       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61606       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
61607       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61608       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
61609       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61610       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61611       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61612       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
61613       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
61614       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
61615       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
61616     required:
61617     - interface-name
61618     - in-maint
61619     properties:
61620       interface-name:
61621         type: string
61622         description: Name that identifies the link aggregate interface
61623       interface-description:
61624         type: string
61625         description: Human friendly text regarding this interface.
61626   lag-interfaces:
61627     description: |
61628       Collection of link aggregate interfaces.
61629     properties:
61630       lag-interface:
61631         type: array
61632         items:
61633           $ref: "#/patchDefinitions/lag-interface"
61634   lag-link:
61635     description: |
61636       LAG links can connect lag-interfaces
61637       ###### Related Nodes
61638       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
61639       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
61640     required:
61641     - link-name
61642     properties:
61643       link-name:
61644         type: string
61645         description: Alphabetical concatenation of lag-interface names
61646   lag-links:
61647     description: |
61648       Collection of link aggregation connections
61649     properties:
61650       lag-link:
61651         type: array
61652         items:
61653           $ref: "#/patchDefinitions/lag-link"
61654   license:
61655     description: |
61656       Metadata for license group.
61657       ###### Related Nodes
61658       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61659       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61660     required:
61661     - group-uuid
61662     - resource-uuid
61663     properties:
61664       group-uuid:
61665         type: string
61666         description: Unique ID for the license group the resource belongs to, should be uuid.
61667       resource-uuid:
61668         type: string
61669         description: Unique ID of a license resource.
61670   licenses:
61671     description: |
61672       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
61673     properties:
61674       license:
61675         type: array
61676         items:
61677           $ref: "#/patchDefinitions/license"
61678   line-of-business:
61679     description: |
61680       describes a line-of-business
61681       ###### Related Nodes
61682       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
61683     required:
61684     - line-of-business-name
61685     properties:
61686       line-of-business-name:
61687         type: string
61688         description: Name of the line-of-business (product)
61689   lines-of-business:
61690     description: |
61691       Collection of lines-of-business
61692     properties:
61693       line-of-business:
61694         type: array
61695         items:
61696           $ref: "#/patchDefinitions/line-of-business"
61697   logical-link:
61698     description: |
61699       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
61700       ###### Related Nodes
61701       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
61702       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
61703       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
61704       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
61705       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
61706       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61707       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
61708       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
61709       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61710       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61711       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
61712       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
61713       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61714       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
61715       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
61716       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
61717       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61718       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61719     required:
61720     - link-name
61721     - in-maint
61722     - link-type
61723     properties:
61724       link-name:
61725         type: string
61726         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
61727       in-maint:
61728         type: boolean
61729       link-type:
61730         type: string
61731         description: Type of logical link, e.g., evc
61732       speed-value:
61733         type: string
61734         description: Captures the numeric part of the speed
61735       speed-units:
61736         type: string
61737         description: Captures the units corresponding to the speed
61738       ip-version:
61739         type: string
61740         description: v4, v6, or ds for dual stack
61741       routing-protocol:
61742         type: string
61743         description: For example, static or BGP
61744   logical-links:
61745     description: |
61746       Collection of logical connections
61747     properties:
61748       logical-link:
61749         type: array
61750         items:
61751           $ref: "#/patchDefinitions/logical-link"
61752   metadata:
61753     description: |
61754       Collection of metadatum (key/value pairs)
61755     properties:
61756       metadatum:
61757         type: array
61758         items:
61759           $ref: "#/patchDefinitions/metadatum"
61760   metadatum:
61761     description: |
61762       Key/value pairs
61763       ###### Related Nodes
61764       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
61765       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
61766       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
61767       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
61768       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61769     required:
61770     - metaname
61771     - metaval
61772     properties:
61773       metaname:
61774         type: string
61775       metaval:
61776         type: string
61777   model:
61778     description: |
61779       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
61780       ###### Related Nodes
61781       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
61782       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
61783       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
61784       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
61785       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
61786       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
61787       - MODEL is DELETED when these are DELETED MODEL-VER
61788     required:
61789     - model-invariant-id
61790     - model-type
61791     properties:
61792       model-invariant-id:
61793         type: string
61794         description: Unique identifier corresponding to the main definition of a model in ASDC
61795       model-type:
61796         type: string
61797         description: Type of the model, e.g., service, resource, widget, etc.
61798   model-and-named-query-search:
61799     description: |
61800       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
61801     properties:
61802       query-parameters:
61803         type: object
61804         $ref: "#/patchDefinitions/query-parameters"
61805       instance-filters:
61806         type: object
61807         $ref: "#/patchDefinitions/instance-filters"
61808       secondary-filts:
61809         type: object
61810         $ref: "#/patchDefinitions/secondary-filts"
61811       top-node-type:
61812         type: string
61813       secondary-filter-cut-point:
61814         type: string
61815   model-constraint:
61816     description: |
61817       This is how we would capture constraints defining allowed sets of elements.
61818       ###### Related Nodes
61819       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
61820       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
61821       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
61822     required:
61823     - model-constraint-uuid
61824     - constrained-element-set-uuid-to-replace
61825     properties:
61826       model-constraint-uuid:
61827         type: string
61828       constrained-element-set-uuid-to-replace:
61829         type: string
61830       constrained-element-sets:
61831         type: array
61832         items:
61833           $ref: "#/patchDefinitions/constrained-element-set"
61834   model-constraints:
61835     properties:
61836       model-constraint:
61837         type: array
61838         items:
61839           $ref: "#/patchDefinitions/model-constraint"
61840   model-element:
61841     description: |
61842       Defines how other models combine to make up a higher-level model.
61843       ###### Related Nodes
61844       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
61845       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
61846       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
61847       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
61848       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
61849       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
61850       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
61851       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
61852     required:
61853     - model-element-uuid
61854     - new-data-del-flag
61855     - cardinality
61856     properties:
61857       model-element-uuid:
61858         type: string
61859       new-data-del-flag:
61860         type: string
61861         description: Indicates whether this element was created as part of instantiation from this model
61862       cardinality:
61863         type: string
61864         description: How many of this type of element are required/allowed
61865       linkage-points:
61866         type: string
61867   model-elements:
61868     properties:
61869       model-element:
61870         type: array
61871         items:
61872           $ref: "#/patchDefinitions/model-element"
61873   model-ver:
61874     description: |
61875       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
61876       ###### Related Nodes
61877       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
61878       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
61879       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
61880       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
61881       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
61882       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
61883       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
61884       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
61885       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
61886       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
61887       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
61888       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
61889     required:
61890     - model-version-id
61891     - model-name
61892     - model-version
61893     properties:
61894       model-version-id:
61895         type: string
61896         description: Unique identifier corresponding to one version of a model in ASDC
61897       model-name:
61898         type: string
61899         description: Name of the model, which can change from version to version.
61900       model-version:
61901         type: string
61902         description: Version
61903       distribution-status:
61904         type: string
61905         description: Distribution Status
61906       model-description:
61907         type: string
61908         description: Description
61909   model-vers:
61910     properties:
61911       model-ver:
61912         type: array
61913         items:
61914           $ref: "#/patchDefinitions/model-ver"
61915   models:
61916     description: |
61917       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
61918     properties:
61919       model:
61920         type: array
61921         items:
61922           $ref: "#/patchDefinitions/model"
61923   multicast-configuration:
61924     description: |
61925       ###### Related Nodes
61926       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
61927     required:
61928     - multicast-configuration-id
61929     - multicast-protocol
61930     - rp-type
61931     properties:
61932       multicast-configuration-id:
61933         type: string
61934         description: Unique id of multicast configuration.
61935       multicast-protocol:
61936         type: string
61937         description: protocol of multicast configuration
61938       rp-type:
61939         type: string
61940         description: rp type of multicast configuration
61941   multicast-configurations:
61942     description: |
61943       multicast configuration of generic-vnf ip-address
61944     properties:
61945       multicast-configuration:
61946         type: array
61947         items:
61948           $ref: "#/patchDefinitions/multicast-configuration"
61949   named-queries:
61950     properties:
61951       named-query:
61952         type: array
61953         items:
61954           $ref: "#/patchDefinitions/named-query"
61955   named-query:
61956     description: |
61957       TBD
61958       ###### Related Nodes
61959       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
61960       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
61961       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
61962       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
61963     required:
61964     - named-query-uuid
61965     - named-query-name
61966     - named-query-version
61967     properties:
61968       named-query-uuid:
61969         type: string
61970       named-query-name:
61971         type: string
61972       named-query-version:
61973         type: string
61974       required-input-param:
61975         type: string
61976       description:
61977         type: string
61978   named-query-element:
61979     description: |
61980       TBD
61981       ###### Related Nodes
61982       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
61983       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
61984       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61985       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61986       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61987       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61988       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
61989     required:
61990     - named-query-element-uuid
61991     properties:
61992       named-query-element-uuid:
61993         type: string
61994       property-collect-list:
61995         type: string
61996   named-query-elements:
61997     properties:
61998       named-query-element:
61999         type: array
62000         items:
62001           $ref: "#/patchDefinitions/named-query-element"
62002   network:
62003     description: |
62004       Namespace for network inventory resources.
62005     properties:
62006       logical-links:
62007         type: array
62008         items:
62009           $ref: "#/patchDefinitions/logical-link"
62010       site-pair-sets:
62011         type: array
62012         items:
62013           $ref: "#/patchDefinitions/site-pair-set"
62014       vpn-bindings:
62015         type: array
62016         items:
62017           $ref: "#/patchDefinitions/vpn-binding"
62018       vpls-pes:
62019         type: array
62020         items:
62021           $ref: "#/patchDefinitions/vpls-pe"
62022       multicast-configurations:
62023         type: array
62024         items:
62025           $ref: "#/patchDefinitions/multicast-configuration"
62026       vces:
62027         type: array
62028         items:
62029           $ref: "#/patchDefinitions/vce"
62030       vnfcs:
62031         type: array
62032         items:
62033           $ref: "#/patchDefinitions/vnfc"
62034       l3-networks:
62035         type: array
62036         items:
62037           $ref: "#/patchDefinitions/l3-network"
62038       network-policies:
62039         type: array
62040         items:
62041           $ref: "#/patchDefinitions/network-policy"
62042       generic-vnfs:
62043         type: array
62044         items:
62045           $ref: "#/patchDefinitions/generic-vnf"
62046       lag-links:
62047         type: array
62048         items:
62049           $ref: "#/patchDefinitions/lag-link"
62050       newvces:
62051         type: array
62052         items:
62053           $ref: "#/patchDefinitions/newvce"
62054       pnfs:
62055         type: array
62056         items:
62057           $ref: "#/patchDefinitions/pnf"
62058       physical-links:
62059         type: array
62060         items:
62061           $ref: "#/patchDefinitions/physical-link"
62062       ipsec-configurations:
62063         type: array
62064         items:
62065           $ref: "#/patchDefinitions/ipsec-configuration"
62066       route-table-references:
62067         type: array
62068         items:
62069           $ref: "#/patchDefinitions/route-table-reference"
62070       instance-groups:
62071         type: array
62072         items:
62073           $ref: "#/patchDefinitions/instance-group"
62074       zones:
62075         type: array
62076         items:
62077           $ref: "#/patchDefinitions/zone"
62078       configurations:
62079         type: array
62080         items:
62081           $ref: "#/patchDefinitions/configuration"
62082       forwarding-paths:
62083         type: array
62084         items:
62085           $ref: "#/patchDefinitions/forwarding-path"
62086   network-policies:
62087     properties:
62088       network-policy:
62089         type: array
62090         items:
62091           $ref: "#/patchDefinitions/network-policy"
62092   network-policy:
62093     description: |
62094       ###### Related Nodes
62095       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
62096       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
62097     required:
62098     - network-policy-id
62099     properties:
62100       network-policy-id:
62101         type: string
62102         description: UUID representing unique key to this instance
62103       network-policy-fqdn:
62104         type: string
62105         description: Contrail FQDN for the policy
62106       heat-stack-id:
62107         type: string
62108         description: ID for the openStack Heat instance
62109   network-profile:
62110     description: |
62111       Network profile populated by SDN-GP for SNMP
62112       ###### Related Nodes
62113       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
62114     required:
62115     - nm-profile-name
62116     properties:
62117       nm-profile-name:
62118         type: string
62119         description: Unique name of network profile.
62120       community-string:
62121         type: string
62122         description: Encrypted SNMP community string
62123   network-profiles:
62124     description: |
62125       Collection of network profiles
62126     properties:
62127       network-profile:
62128         type: array
62129         items:
62130           $ref: "#/patchDefinitions/network-profile"
62131   newvce:
62132     description: |
62133       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
62134       ###### Related Nodes
62135       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
62136       - NEWVCE is DELETED when these are DELETED L-INTERFACE
62137     required:
62138     - vnf-id2
62139     - vnf-name
62140     - vnf-type
62141     properties:
62142       vnf-id2:
62143         type: string
62144         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
62145       vnf-name:
62146         type: string
62147         description: Name of VNF.
62148       vnf-name2:
62149         type: string
62150         description: Alternate name of VNF.
62151       vnf-type:
62152         type: string
62153         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.
62154       prov-status:
62155         type: string
62156         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62157       operational-status:
62158         type: string
62159         description: Indicator for whether the resource is considered operational
62160       license-key:
62161         type: string
62162         description: OBSOLETE -  do not use
62163       ipv4-oam-address:
62164         type: string
62165         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).
62166       equipment-role:
62167         type: string
62168         description: Client should send valid enumerated value.
62169   newvces:
62170     description: |
62171       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
62172     properties:
62173       newvce:
62174         type: array
62175         items:
62176           $ref: "#/patchDefinitions/newvce"
62177   notification-event:
62178     properties:
62179       cambria.partition:
62180         type: string
62181       notification-event-header:
62182         type: object
62183         $ref: "#/patchDefinitions/notification-event-header"
62184   notification-event-header:
62185     properties:
62186       id:
62187         type: string
62188       timestamp:
62189         type: string
62190       source-name:
62191         type: string
62192       domain:
62193         type: string
62194       sequence-number:
62195         type: string
62196       severity:
62197         type: string
62198       event-type:
62199         type: string
62200       version:
62201         type: string
62202       action:
62203         type: string
62204       entity-type:
62205         type: string
62206       top-entity-type:
62207         type: string
62208       entity-link:
62209         type: string
62210       status:
62211         type: string
62212   notify:
62213     required:
62214     - event-id
62215     properties:
62216       event-id:
62217         type: string
62218       node-type:
62219         type: string
62220       event-trigger:
62221         type: string
62222       key-data:
62223         type: array
62224         items:
62225           $ref: "#/patchDefinitions/key-data"
62226       selflink:
62227         type: string
62228   oam-network:
62229     description: |
62230       OAM network, to be deprecated shortly.  Do not use for new purposes.
62231       ###### Related Nodes
62232       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62233       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
62234       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
62235     required:
62236     - network-uuid
62237     - network-name
62238     - cvlan-tag
62239     properties:
62240       network-uuid:
62241         type: string
62242         description: UUID of the network. Unique across a cloud-region
62243       network-name:
62244         type: string
62245         description: Name of the network.
62246       cvlan-tag:
62247         type: integer
62248         format: int64
62249         description: cvlan-id
62250       ipv4-oam-gateway-address:
62251         type: string
62252         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
62253       ipv4-oam-gateway-address-prefix-length:
62254         type: integer
62255         format: int32
62256         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
62257   oam-networks:
62258     description: |
62259       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
62260     properties:
62261       oam-network:
62262         type: array
62263         items:
62264           $ref: "#/patchDefinitions/oam-network"
62265   operational-environment:
62266     description: |
62267       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
62268       ###### Related Nodes
62269       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
62270       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
62271     required:
62272     - operational-environment-id
62273     - operational-environment-name
62274     - operational-environment-type
62275     - operational-environment-status
62276     - tenant-context
62277     - workload-context
62278     properties:
62279       operational-environment-id:
62280         type: string
62281         description: UUID of an operational environment
62282       operational-environment-name:
62283         type: string
62284         description: Operational Environment name
62285       operational-environment-type:
62286         type: string
62287         description: Operational Environment Type.
62288       operational-environment-status:
62289         type: string
62290         description: Status
62291       tenant-context:
62292         type: string
62293         description: Tenant Context.
62294       workload-context:
62295         type: string
62296         description: Workload Context.
62297   operational-environments:
62298     description: |
62299       a logical partition of the cloud which allows to have multiple environments in the production AIC.
62300     properties:
62301       operational-environment:
62302         type: array
62303         items:
62304           $ref: "#/patchDefinitions/operational-environment"
62305   overloaded-model:
62306     description: |
62307       Allows for legacy POST of old-style and new-style models
62308     required:
62309     - model-invariant-id
62310     - model-name-version-id
62311     - model-type
62312     - model-name
62313     - model-id
62314     - model-version
62315     properties:
62316       model-invariant-id:
62317         type: string
62318         description: Unique identifier corresponding to the main definition of a model in ASDC
62319       model-name-version-id:
62320         type: string
62321         description: Unique identifier corresponding to one version of a model in ASDC
62322       model-type:
62323         type: string
62324         description: Type of the model, e.g., service, resource, widget, etc.
62325       model-name:
62326         type: string
62327         description: Name of the model, which can change from version to version.
62328       model-id:
62329         type: string
62330         description: Invariant unique ID which does not change from version to version
62331       model-version:
62332         type: string
62333         description: Version
62334       model-description:
62335         type: string
62336         description: Description
62337   owning-entities:
62338     description: |
62339       Collection of owning-entities
62340     properties:
62341       owning-entity:
62342         type: array
62343         items:
62344           $ref: "#/patchDefinitions/owning-entity"
62345   owning-entity:
62346     description: |
62347       describes an owning-entity
62348       ###### Related Nodes
62349       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
62350     required:
62351     - owning-entity-id
62352     - owning-entity-name
62353     properties:
62354       owning-entity-id:
62355         type: string
62356         description: UUID of an owning entity
62357       owning-entity-name:
62358         type: string
62359         description: Owning entity name
62360   p-interface:
62361     description: |
62362       Physical interface (e.g., nic)
62363       ###### Related Nodes
62364       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
62365       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
62366       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
62367       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
62368       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62369       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
62370       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
62371       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
62372       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
62373       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
62374       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
62375     required:
62376     - interface-name
62377     - in-maint
62378     properties:
62379       interface-name:
62380         type: string
62381         description: Name that identifies the physical interface
62382       selflink:
62383         type: string
62384         description: URL to endpoint where AAI can get more details.
62385       speed-value:
62386         type: string
62387         description: Captures the numeric part of the speed
62388       speed-units:
62389         type: string
62390         description: Captures the units corresponding to the speed
62391       port-description:
62392         type: string
62393         description: Nature of the services and connectivity on this port.
62394       equipment-identifier:
62395         type: string
62396         description: CLEI or other specification for p-interface hardware.
62397       interface-role:
62398         type: string
62399         description: Role specification for p-interface hardware.
62400       interface-type:
62401         type: string
62402         description: Indicates the physical properties of the interface.
62403       prov-status:
62404         type: string
62405         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62406       mac-addresss:
62407         type: string
62408         description: MAC Address of the p-interface.
62409   p-interfaces:
62410     description: |
62411       Collection of physical interfaces.
62412     properties:
62413       p-interface:
62414         type: array
62415         items:
62416           $ref: "#/patchDefinitions/p-interface"
62417   physical-link:
62418     description: |
62419       Collection of physical connections, typically between p-interfaces
62420       ###### Related Nodes
62421       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
62422     required:
62423     - link-name
62424     properties:
62425       link-name:
62426         type: string
62427         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
62428       speed-value:
62429         type: string
62430         description: Captures the numeric part of the speed
62431       speed-units:
62432         type: string
62433         description: Captures the units corresponding to the speed
62434       circuit-id:
62435         type: string
62436         description: Circuit it
62437       dual-mode:
62438         type: string
62439         description: Dual access mode (e.g., primary, secondary
62440       management-option:
62441         type: string
62442         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
62443       service-provider-name:
62444         type: string
62445         description: Name of the service Provider on this link.
62446       service-provider-bandwidth-up-value:
62447         type: integer
62448         format: int32
62449         description: Upstream Bandwidth value agreed with the service provider
62450       service-provider-bandwidth-up-units:
62451         type: string
62452         description: Units for the upstream BW value
62453       service-provider-bandwidth-down-value:
62454         type: integer
62455         format: int32
62456         description: Downstream Bandwidth value agreed with the service provider
62457       service-provider-bandwidth-down-units:
62458         type: string
62459         description: Units for downstream BW value
62460   physical-links:
62461     description: |
62462       Collection of physical connections, typically between p-interfaces
62463     properties:
62464       physical-link:
62465         type: array
62466         items:
62467           $ref: "#/patchDefinitions/physical-link"
62468   platform:
62469     description: |
62470       describes a platform
62471       ###### Related Nodes
62472       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
62473     required:
62474     - platform-name
62475     properties:
62476       platform-name:
62477         type: string
62478         description: Name of the platform
62479   platforms:
62480     description: |
62481       Collection of platforms
62482     properties:
62483       platform:
62484         type: array
62485         items:
62486           $ref: "#/patchDefinitions/platform"
62487   pnf:
62488     description: |
62489       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.
62490       ###### Related Nodes
62491       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62492       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62493       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62494       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
62495       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
62496       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
62497       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
62498       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
62499       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
62500       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
62501       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62502     required:
62503     - pnf-name
62504     - in-maint
62505     properties:
62506       pnf-name:
62507         type: string
62508         description: unique name of Physical Network Function.
62509       pnf-name2:
62510         type: string
62511         description: name of Physical Network Function.
62512       selflink:
62513         type: string
62514         description: URL to endpoint where AAI can get more details.
62515       pnf-name2-source:
62516         type: string
62517         description: source of name2
62518       pnf-id:
62519         type: string
62520         description: id of pnf
62521       equip-type:
62522         type: string
62523         description: Equipment type.  Source of truth should define valid values.
62524       equip-vendor:
62525         type: string
62526         description: Equipment vendor.  Source of truth should define valid values.
62527       equip-model:
62528         type: string
62529         description: Equipment model.  Source of truth should define valid values.
62530       management-option:
62531         type: string
62532         description: identifier of managed by ATT or customer
62533       ipaddress-v4-oam:
62534         type: string
62535         description: ipv4-oam-address with new naming convention for IP addresses
62536       sw-version:
62537         type: string
62538         description: sw-version is the version of SW for the hosted application on the PNF.
62539       in-maint:
62540         type: boolean
62541       frame-id:
62542         type: string
62543         description: ID of the physical frame (relay rack) where pnf is installed.
62544       serial-number:
62545         type: string
62546         description: Serial number of the device
62547       ipaddress-v4-loopback-0:
62548         type: string
62549         description: IPV4 Loopback 0 address
62550       ipaddress-v6-loopback-0:
62551         type: string
62552         description: IPV6 Loopback 0 address
62553       ipaddress-v4-aim:
62554         type: string
62555         description: IPV4 AIM address
62556       ipaddress-v6-aim:
62557         type: string
62558         description: IPV6 AIM address
62559       ipaddress-v6-oam:
62560         type: string
62561         description: IPV6 OAM address
62562       inv-status:
62563         type: string
62564         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
62565   pnfs:
62566     description: |
62567       Collection of Physical Network Functions.
62568     properties:
62569       pnf:
62570         type: array
62571         items:
62572           $ref: "#/patchDefinitions/pnf"
62573   port-group:
62574     description: |
62575       Used to capture the network interfaces of this VCE
62576       ###### Related Nodes
62577       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62578       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
62579       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
62580     required:
62581     - interface-id
62582     - orchestration-status
62583     properties:
62584       interface-id:
62585         type: string
62586         description: Unique ID of the interface
62587       neutron-network-id:
62588         type: string
62589         description: Neutron network id of this Interface
62590       neutron-network-name:
62591         type: string
62592         description: Neutron network name of this Interface
62593       interface-role:
62594         type: string
62595         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
62596   port-groups:
62597     properties:
62598       port-group:
62599         type: array
62600         items:
62601           $ref: "#/patchDefinitions/port-group"
62602   project:
62603     description: |
62604       describes the project
62605       ###### Related Nodes
62606       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
62607     required:
62608     - project-name
62609     properties:
62610       project-name:
62611         type: string
62612         description: Name of the project deploying a service
62613   projects:
62614     description: |
62615       Collection of projects
62616     properties:
62617       project:
62618         type: array
62619         items:
62620           $ref: "#/patchDefinitions/project"
62621   properties:
62622     description: |
62623       Property holder for query properties or instance properties
62624     properties:
62625       property-name:
62626         type: string
62627       property-value:
62628         type: string
62629   property-constraint:
62630     description: |
62631       TBD
62632       ###### Related Nodes
62633       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62634     required:
62635     - property-constraint-uuid
62636     - constraint-type
62637     - property-name
62638     - property-value
62639     properties:
62640       property-constraint-uuid:
62641         type: string
62642       constraint-type:
62643         type: string
62644       property-name:
62645         type: string
62646       property-value:
62647         type: string
62648   property-constraints:
62649     properties:
62650       property-constraint:
62651         type: array
62652         items:
62653           $ref: "#/patchDefinitions/property-constraint"
62654   pserver:
62655     description: |
62656       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
62657       ###### Related Nodes
62658       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
62659       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
62660       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
62661       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62662       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62663       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
62664       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
62665       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
62666       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
62667       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
62668       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
62669       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62670       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
62671     required:
62672     - hostname
62673     - in-maint
62674     properties:
62675       hostname:
62676         type: string
62677         description: Value from executing hostname on the compute node.
62678       ptnii-equip-name:
62679         type: string
62680         description: PTNII name
62681       number-of-cpus:
62682         type: integer
62683         format: int32
62684         description: Number of cpus
62685       disk-in-gigabytes:
62686         type: integer
62687         format: int32
62688         description: Disk size, in GBs
62689       ram-in-megabytes:
62690         type: integer
62691         format: int32
62692         description: RAM size, in MBs
62693       equip-type:
62694         type: string
62695         description: Equipment type.  Source of truth should define valid values.
62696       equip-vendor:
62697         type: string
62698         description: Equipment vendor.  Source of truth should define valid values.
62699       equip-model:
62700         type: string
62701         description: Equipment model.  Source of truth should define valid values.
62702       fqdn:
62703         type: string
62704         description: Fully-qualified domain name
62705       pserver-selflink:
62706         type: string
62707         description: URL to endpoint where AAI can get more details
62708       ipv4-oam-address:
62709         type: string
62710         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
62711       serial-number:
62712         type: string
62713         description: Serial number, may be queried
62714       ipaddress-v4-loopback-0:
62715         type: string
62716         description: IPV4 Loopback 0 address
62717       ipaddress-v6-loopback-0:
62718         type: string
62719         description: IPV6 Loopback 0 address
62720       ipaddress-v4-aim:
62721         type: string
62722         description: IPV4 AIM address
62723       ipaddress-v6-aim:
62724         type: string
62725         description: IPV6 AIM address
62726       ipaddress-v6-oam:
62727         type: string
62728         description: IPV6 OAM address
62729       inv-status:
62730         type: string
62731         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
62732       pserver-id:
62733         type: string
62734         description: ID of Pserver
62735       internet-topology:
62736         type: string
62737         description: internet topology of Pserver
62738       in-maint:
62739         type: boolean
62740   pservers:
62741     description: |
62742       Collection of compute hosts.
62743     properties:
62744       pserver:
62745         type: array
62746         items:
62747           $ref: "#/patchDefinitions/pserver"
62748   query-parameters:
62749     description: |
62750       QueryParameters for performing a named-query or model query
62751     properties:
62752       named-query:
62753         type: object
62754         $ref: "#/patchDefinitions/named-query"
62755       overloaded-model:
62756         type: object
62757         $ref: "#/patchDefinitions/overloaded-model"
62758   related-lookup:
62759     description: |
62760       TBD
62761       ###### Related Nodes
62762       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
62763     required:
62764     - related-lookup-uuid
62765     - source-node-type
62766     - source-node-property
62767     - target-node-type
62768     - target-node-property
62769     properties:
62770       related-lookup-uuid:
62771         type: string
62772       source-node-type:
62773         type: string
62774       source-node-property:
62775         type: string
62776       target-node-type:
62777         type: string
62778       target-node-property:
62779         type: string
62780       property-collect-list:
62781         type: string
62782   related-lookups:
62783     properties:
62784       related-lookup:
62785         type: array
62786         items:
62787           $ref: "#/patchDefinitions/related-lookup"
62788   related-to-property:
62789     properties:
62790       property-key:
62791         type: string
62792         description: Key part of a key/value pair
62793       property-value:
62794         type: string
62795         description: Value part of a key/value pair
62796   relationship:
62797     properties:
62798       related-to:
62799         type: string
62800         description: A keyword provided by A&AI to indicate type of node.
62801       relationship-label:
62802         type: string
62803         description: The edge label for this relationship.
62804       related-link:
62805         type: string
62806         description: URL to the object in A&AI.
62807       relationship-data:
62808         type: array
62809         items:
62810           $ref: "#/patchDefinitions/relationship-data"
62811       related-to-property:
62812         type: array
62813         items:
62814           $ref: "#/patchDefinitions/related-to-property"
62815   relationship-data:
62816     required:
62817     - relationship-key
62818     - relationship-value
62819     properties:
62820       relationship-key:
62821         type: string
62822         description: A keyword provided by A&AI to indicate an attribute.
62823       relationship-value:
62824         type: string
62825         description: Value of the attribute.
62826   reserved-prop-names:
62827     description: |
62828       Internal map to define some reserved properties of a vertex
62829     properties:
62830       last-mod-source-of-truth:
62831         type: string
62832       aai-node-type:
62833         type: string
62834       aai-created-ts:
62835         type: integer
62836         format: int64
62837       aai-unique-key:
62838         type: string
62839       aai-last-mod-ts:
62840         type: integer
62841         format: int64
62842       source-of-truth:
62843         type: string
62844       aai-uri:
62845         type: string
62846   response-list:
62847     description: |
62848       Response container for the results of a named-query or model query
62849     properties:
62850       inventory-response-items:
62851         type: object
62852         $ref: "#/patchDefinitions/inventory-response-items"
62853   result-data:
62854     properties:
62855       resource-type:
62856         type: string
62857         description: The specific type of node in the A&AI graph
62858       resource-link:
62859         type: string
62860         description: The URL to the specific resource
62861   route-table-reference:
62862     description: |
62863       Openstack route table reference.
62864       ###### Related Nodes
62865       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
62866     required:
62867     - route-table-reference-id
62868     - route-table-reference-fqdn
62869     properties:
62870       route-table-reference-id:
62871         type: string
62872         description: Route Table Reference id, UUID assigned to this instance.
62873       route-table-reference-fqdn:
62874         type: string
62875         description: FQDN entry in the route table.
62876   route-table-references:
62877     description: |
62878       Collection of openstack route table references
62879     properties:
62880       route-table-reference:
62881         type: array
62882         items:
62883           $ref: "#/patchDefinitions/route-table-reference"
62884   route-target:
62885     description: |
62886       Route target information
62887       ###### Related Nodes
62888       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
62889     required:
62890     - global-route-target
62891     - route-target-role
62892     properties:
62893       global-route-target:
62894         type: string
62895         description: Number used to identify an RT, globally unique in the network
62896       route-target-role:
62897         type: string
62898         description: Role assigned to this route target
62899   route-targets:
62900     description: |
62901       Collection of route target information
62902     properties:
62903       route-target:
62904         type: array
62905         items:
62906           $ref: "#/patchDefinitions/route-target"
62907   routing-instance:
62908     description: |
62909       ###### Related Nodes
62910       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
62911       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
62912       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
62913     required:
62914     - routing-instance-id
62915     properties:
62916       routing-instance-id:
62917         type: string
62918         description: Unique id of routing instance
62919       rpm-owner:
62920         type: string
62921         description: rpm owner
62922   routing-instances:
62923     description: |
62924       set of probes related to generic-vnf routing instance
62925     properties:
62926       routing-instance:
62927         type: array
62928         items:
62929           $ref: "#/patchDefinitions/routing-instance"
62930   sdn-zone-response:
62931     properties:
62932       oam-networks:
62933         type: object
62934         $ref: "#/patchDefinitions/oam-networks"
62935       az-and-dvs-switches:
62936         type: array
62937         items:
62938           $ref: "#/patchDefinitions/az-and-dvs-switches"
62939   search:
62940     properties:
62941       edge-tag-query-result:
62942         type: object
62943         $ref: "#/patchDefinitions/edge-tag-query-result"
62944       edge-tag-query-request:
62945         type: object
62946         $ref: "#/patchDefinitions/edge-tag-query-request"
62947       search-results:
62948         type: object
62949         $ref: "#/patchDefinitions/search-results"
62950       sdn-zone-response:
62951         type: object
62952         $ref: "#/patchDefinitions/sdn-zone-response"
62953   search-results:
62954     properties:
62955       result-data:
62956         type: array
62957         items:
62958           $ref: "#/patchDefinitions/result-data"
62959   secondary-filt:
62960     description: |
62961       SecondaryFilt for performing a named-query or model query
62962   secondary-filter:
62963     properties:
62964       property-name:
62965         type: string
62966       filter-type:
62967         type: string
62968       property-value:
62969         type: string
62970   secondary-filts:
62971     description: |
62972       SecondaryFilts for performing a named-query or model query
62973     properties:
62974       secondary-filt:
62975         type: array
62976         items:
62977           $ref: "#/patchDefinitions/secondary-filt"
62978   segmentation-assignment:
62979     description: |
62980       Openstack segmentation assignment.
62981       ###### Related Nodes
62982       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
62983     required:
62984     - segmentation-id
62985     properties:
62986       segmentation-id:
62987         type: string
62988         description: Route Table Reference id, UUID assigned to this instance.
62989   segmentation-assignments:
62990     description: |
62991       Collection of openstack segmentation assignments
62992     properties:
62993       segmentation-assignment:
62994         type: array
62995         items:
62996           $ref: "#/patchDefinitions/segmentation-assignment"
62997   service:
62998     description: |
62999       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
63000     required:
63001     - service-id
63002     - service-description
63003     properties:
63004       service-id:
63005         type: string
63006         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
63007       service-description:
63008         type: string
63009         description: Description of the service
63010       service-selflink:
63011         type: string
63012         description: URL to endpoint where AAI can get more details
63013   service-capabilities:
63014     description: |
63015       Collection of service capabilities.
63016     properties:
63017       service-capability:
63018         type: array
63019         items:
63020           $ref: "#/patchDefinitions/service-capability"
63021   service-capability:
63022     description: |
63023       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
63024       ###### Related Nodes
63025       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
63026       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
63027       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
63028     required:
63029     - service-type
63030     - vnf-type
63031     properties:
63032       service-type:
63033         type: string
63034         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
63035       vnf-type:
63036         type: string
63037         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.
63038   service-design-and-creation:
63039     description: |
63040       Namespace for objects managed by ASDC
63041     properties:
63042       vnf-images:
63043         type: array
63044         items:
63045           $ref: "#/patchDefinitions/vnf-image"
63046       services:
63047         type: array
63048         items:
63049           $ref: "#/patchDefinitions/service"
63050       service-capabilities:
63051         type: array
63052         items:
63053           $ref: "#/patchDefinitions/service-capability"
63054       models:
63055         type: array
63056         items:
63057           $ref: "#/patchDefinitions/model"
63058       named-queries:
63059         type: array
63060         items:
63061           $ref: "#/patchDefinitions/named-query"
63062   service-instance:
63063     description: |
63064       Instance of a service
63065       ###### Related Nodes
63066       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
63067       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
63068       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
63069       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
63070       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
63071       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
63072       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
63073       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
63074       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63075       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
63076       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
63077       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
63078       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
63079       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63080       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
63081       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
63082       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
63083       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
63084       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
63085       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
63086       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
63087       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
63088       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
63089       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
63090     required:
63091     - service-instance-id
63092     - service-type
63093     - service-role
63094     - created-at
63095     - updated-at
63096     - description
63097     properties:
63098       service-instance-id:
63099         type: string
63100         description: Uniquely identifies this instance of a service
63101       service-instance-name:
63102         type: string
63103         description: This field will store a name assigned to the service-instance.
63104       service-type:
63105         type: string
63106         description: String capturing type of service.
63107       service-role:
63108         type: string
63109         description: String capturing the service role.
63110       environment-context:
63111         type: string
63112         description: This field will store the environment context assigned to the service-instance.
63113       workload-context:
63114         type: string
63115         description: This field will store the workload context assigned to the service-instance.
63116       created-at:
63117         type: string
63118         description: create time of Network Service.
63119       updated-at:
63120         type: string
63121         description: last update of Network Service.
63122       description:
63123         type: string
63124         description: short description for service-instance.
63125       model-invariant-id:
63126         type: string
63127         description: the ASDC model id for this resource or service model.
63128       model-version-id:
63129         type: string
63130         description: the ASDC model version for this resource or service model.
63131       persona-model-version:
63132         type: string
63133         description: the ASDC model version for this resource or service model.
63134       widget-model-id:
63135         type: string
63136         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
63137       widget-model-version:
63138         type: string
63139         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
63140       bandwidth-total:
63141         type: string
63142         description: Indicates the total bandwidth to be used for this service.
63143       bandwidth-up-wan1:
63144         type: string
63145         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
63146       bandwidth-down-wan1:
63147         type: string
63148         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
63149       bandwidth-up-wan2:
63150         type: string
63151         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
63152       bandwidth-down-wan2:
63153         type: string
63154         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
63155       vhn-portal-url:
63156         type: string
63157         description: URL customers will use to access the vHN Portal.
63158       service-instance-location-id:
63159         type: string
63160         description: An identifier that customers assign to the location where this service is being used.
63161   service-instances:
63162     description: |
63163       Collection of service instances
63164     properties:
63165       service-instance:
63166         type: array
63167         items:
63168           $ref: "#/patchDefinitions/service-instance"
63169   service-subscription:
63170     description: |
63171       Object that group service instances.
63172       ###### Related Nodes
63173       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
63174       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
63175       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
63176       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
63177     required:
63178     - service-type
63179     properties:
63180       service-type:
63181         type: string
63182         description: Value defined by orchestration to identify this service across ECOMP.
63183       temp-ub-sub-account-id:
63184         type: string
63185         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
63186   service-subscriptions:
63187     description: |
63188       Collection of objects that group service instances.
63189     properties:
63190       service-subscription:
63191         type: array
63192         items:
63193           $ref: "#/patchDefinitions/service-subscription"
63194   services:
63195     description: |
63196       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
63197     properties:
63198       service:
63199         type: array
63200         items:
63201           $ref: "#/patchDefinitions/service"
63202   site-pair:
63203     description: |
63204       ###### Related Nodes
63205       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
63206       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
63207       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
63208     required:
63209     - site-pair-id
63210     properties:
63211       site-pair-id:
63212         type: string
63213         description: unique identifier of probe
63214       source-ip:
63215         type: string
63216         description: Prefix address
63217       destination-ip:
63218         type: string
63219         description: Prefix address
63220       ip-version:
63221         type: string
63222         description: ip version, v4, v6
63223       destination-hostname:
63224         type: string
63225         description: Hostname of the destination equipment to which SLAs are measured against.
63226       destination-equip-type:
63227         type: string
63228         description: The type of destinatination equipment. Could be Router, UCPE, etc.
63229   site-pair-set:
63230     description: |
63231       Set of instances for probes used to measure service level agreements
63232       ###### Related Nodes
63233       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
63234       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
63235       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
63236     required:
63237     - site-pair-set-id
63238     properties:
63239       site-pair-set-id:
63240         type: string
63241         description: Unique id of site pair set.
63242   site-pair-sets:
63243     description: |
63244       Collection of sets of instances for probes related to generic-vnf
63245     properties:
63246       site-pair-set:
63247         type: array
63248         items:
63249           $ref: "#/patchDefinitions/site-pair-set"
63250   site-pairs:
63251     description: |
63252       probe within a set
63253     properties:
63254       site-pair:
63255         type: array
63256         items:
63257           $ref: "#/patchDefinitions/site-pair"
63258   snapshot:
63259     description: |
63260       Openstack snapshot
63261       ###### Related Nodes
63262       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63263       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
63264     required:
63265     - snapshot-id
63266     properties:
63267       snapshot-id:
63268         type: string
63269         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
63270       snapshot-name:
63271         type: string
63272         description: Snapshot name
63273       snapshot-architecture:
63274         type: string
63275         description: Operating system architecture
63276       snapshot-os-distro:
63277         type: string
63278         description: The common name of the operating system distribution in lowercase
63279       snapshot-os-version:
63280         type: string
63281         description: The operating system version as specified by the distributor.
63282       application:
63283         type: string
63284         description: The application that the image instantiates.
63285       application-vendor:
63286         type: string
63287         description: The vendor of the application.
63288       application-version:
63289         type: string
63290         description: The version of the application.
63291       snapshot-selflink:
63292         type: string
63293         description: URL to endpoint where AAI can get more details
63294       prev-snapshot-id:
63295         type: string
63296         description: This field contains the UUID of the previous snapshot (if any).
63297   snapshots:
63298     description: |
63299       Collection of openstack snapshots
63300     properties:
63301       snapshot:
63302         type: array
63303         items:
63304           $ref: "#/patchDefinitions/snapshot"
63305   sriov-pf:
63306     description: |
63307       SR-IOV Physical Function
63308       ###### Related Nodes
63309       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
63310       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
63311     required:
63312     - pf-pci-id
63313     properties:
63314       pf-pci-id:
63315         type: string
63316         description: Identifier for the sriov-pf
63317   sriov-pfs:
63318     description: |
63319       Collection of SR-IOV Physical Functions.
63320     properties:
63321       sriov-pf:
63322         type: array
63323         items:
63324           $ref: "#/patchDefinitions/sriov-pf"
63325   sriov-vf:
63326     description: |
63327       SR-IOV Virtual Function (not to be confused with virtual network function)
63328       ###### Related Nodes
63329       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
63330       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
63331     required:
63332     - pci-id
63333     properties:
63334       pci-id:
63335         type: string
63336         description: PCI ID used to identify the sriov-vf
63337       vf-vlan-filter:
63338         type: string
63339         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
63340       vf-mac-filter:
63341         type: string
63342         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
63343       vf-vlan-strip:
63344         type: boolean
63345         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
63346       vf-vlan-anti-spoof-check:
63347         type: boolean
63348         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.
63349       vf-mac-anti-spoof-check:
63350         type: boolean
63351         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.
63352       vf-mirrors:
63353         type: string
63354         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
63355       vf-broadcast-allow:
63356         type: boolean
63357         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
63358       vf-unknown-multicast-allow:
63359         type: boolean
63360         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
63361       vf-unknown-unicast-allow:
63362         type: boolean
63363         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
63364       vf-insert-stag:
63365         type: boolean
63366         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
63367       vf-link-status:
63368         type: string
63369         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
63370   sriov-vfs:
63371     description: |
63372       Collection of SR-IOV Virtual Functions.
63373     properties:
63374       sriov-vf:
63375         type: array
63376         items:
63377           $ref: "#/patchDefinitions/sriov-vf"
63378   start-node-filter:
63379     properties:
63380       property-name:
63381         type: string
63382       property-value:
63383         type: string
63384   subnet:
63385     description: |
63386       ###### Related Nodes
63387       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
63388       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
63389       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
63390       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
63391       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
63392       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
63393       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
63394       - SUBNET is DELETED when these are DELETED HOST-ROUTE
63395     required:
63396     - subnet-id
63397     - dhcp-enabled
63398     properties:
63399       subnet-id:
63400         type: string
63401         description: Subnet ID, should be UUID.
63402       subnet-name:
63403         type: string
63404         description: Name associated with the subnet.
63405       neutron-subnet-id:
63406         type: string
63407         description: Neutron id of this subnet
63408       gateway-address:
63409         type: string
63410         description: gateway ip address
63411       network-start-address:
63412         type: string
63413         description: network start address
63414       cidr-mask:
63415         type: string
63416         description: cidr mask
63417       ip-version:
63418         type: string
63419         description: ip version
63420       orchestration-status:
63421         type: string
63422         description: Orchestration status of this VNF, mastered by MSO
63423       dhcp-enabled:
63424         type: boolean
63425       dhcp-start:
63426         type: string
63427         description: the start address reserved for use by dhcp
63428       dhcp-end:
63429         type: string
63430         description: the last address reserved for use by dhcp
63431       subnet-role:
63432         type: string
63433         description: role of the subnet, referenced when assigning IPs
63434       ip-assignment-direction:
63435         type: string
63436         description: ip address assignment direction of the subnet
63437   subnets:
63438     properties:
63439       subnet:
63440         type: array
63441         items:
63442           $ref: "#/patchDefinitions/subnet"
63443   tagged-inventory-item-list:
63444     properties:
63445       inventory-item:
63446         type: array
63447         items:
63448           $ref: "#/patchDefinitions/inventory-item"
63449   tenant:
63450     description: |
63451       Openstack tenant
63452       ###### Related Nodes
63453       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63454       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
63455       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
63456       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
63457       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
63458       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
63459       - TENANT cannot be deleted if linked to VSERVER
63460     required:
63461     - tenant-id
63462     - tenant-name
63463     properties:
63464       tenant-id:
63465         type: string
63466         description: Unique id relative to the cloud-region.
63467       tenant-name:
63468         type: string
63469         description: Readable name of tenant
63470       tenant-context:
63471         type: string
63472         description: This field will store the tenant context.
63473   tenants:
63474     description: |
63475       Collection of openstack tenants.
63476     properties:
63477       tenant:
63478         type: array
63479         items:
63480           $ref: "#/patchDefinitions/tenant"
63481   tunnel-xconnect:
63482     description: |
63483       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
63484       ###### Related Nodes
63485       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
63486     required:
63487     - id
63488     properties:
63489       id:
63490         type: string
63491         description: Allotted Resource id UUID assigned to this instance.
63492       bandwidth-up-wan1:
63493         type: string
63494         description: The WAN uplink bandwidth for WAN1
63495       bandwidth-down-wan1:
63496         type: string
63497         description: The WAN downlink bandwidth for WAN1
63498       bandwidth-up-wan2:
63499         type: string
63500         description: The WAN uplink bandwidth for WAN2
63501       bandwidth-down-wan2:
63502         type: string
63503         description: The WAN downlink bandwidth for WAN2
63504   tunnel-xconnects:
63505     description: |
63506       This object is used to store the specific tunnel cross connect aspects of an allotted resource
63507     properties:
63508       tunnel-xconnect:
63509         type: array
63510         items:
63511           $ref: "#/patchDefinitions/tunnel-xconnect"
63512   update:
63513     description: |
63514       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
63515     required:
63516     - update-node-type
63517     properties:
63518       update-node-type:
63519         type: string
63520       update-node-key:
63521         type: array
63522         items:
63523           $ref: "#/patchDefinitions/update-node-key"
63524       update-node-uri:
63525         type: string
63526       action:
63527         type: array
63528         items:
63529           $ref: "#/patchDefinitions/action"
63530   update-node-key:
63531     properties:
63532       key-name:
63533         type: string
63534       key-value:
63535         type: string
63536   vce:
63537     description: |
63538       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
63539       ###### Related Nodes
63540       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
63541       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
63542       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
63543       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63544       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63545       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63546       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
63547       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
63548     required:
63549     - vnf-id
63550     - vnf-name
63551     - vnf-type
63552     properties:
63553       vnf-id:
63554         type: string
63555         description: Unique id of VNF.  This is unique across the graph.
63556       vnf-name:
63557         type: string
63558         description: Name of VNF.
63559       vnf-name2:
63560         type: string
63561         description: Alternate name of VNF.
63562       vnf-type:
63563         type: string
63564         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.
63565       service-id:
63566         type: string
63567         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
63568       regional-resource-zone:
63569         type: string
63570         description: Regional way of organizing pservers, source of truth should define values
63571       prov-status:
63572         type: string
63573         description: Trigger for operational monitoring of this resource by Service Assurance systems.
63574       operational-status:
63575         type: string
63576         description: Indicator for whether the resource is considered operational
63577       license-key:
63578         type: string
63579         description: OBSOLETE -  do not use
63580       equipment-role:
63581         type: string
63582         description: Network role being played by this VNF
63583       orchestration-status:
63584         type: string
63585         description: Orchestration status of this VNF, mastered by MSO
63586       heat-stack-id:
63587         type: string
63588         description: Heat stack id corresponding to this instance, managed by MSO
63589       mso-catalog-key:
63590         type: string
63591         description: Corresponds to the SDN-C catalog id used to configure this VCE
63592       vpe-id:
63593         type: string
63594         description: Unique ID of VPE connected to this VCE.
63595       v6-vce-wan-address:
63596         type: string
63597         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
63598       ipv4-oam-address:
63599         type: string
63600         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
63601   vces:
63602     description: |
63603       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
63604     properties:
63605       vce:
63606         type: array
63607         items:
63608           $ref: "#/patchDefinitions/vce"
63609   vf-module:
63610     description: |
63611       a deployment unit of VNFCs
63612       ###### Related Nodes
63613       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63614       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
63615       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
63616       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
63617       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
63618       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
63619       - VF-MODULE cannot be deleted if linked to VNFC
63620     required:
63621     - vf-module-id
63622     - is-base-vf-module
63623     properties:
63624       vf-module-id:
63625         type: string
63626         description: Unique ID of vf-module.
63627       vf-module-name:
63628         type: string
63629         description: Name of vf-module
63630       heat-stack-id:
63631         type: string
63632         description: Heat stack id corresponding to this instance.
63633       orchestration-status:
63634         type: string
63635         description: orchestration status of this vf-module, mastered by MSO
63636       is-base-vf-module:
63637         type: boolean
63638   vf-modules:
63639     description: |
63640       Collection of vf-modules, a deployment unit of VNFCs
63641     properties:
63642       vf-module:
63643         type: array
63644         items:
63645           $ref: "#/patchDefinitions/vf-module"
63646   vig-server:
63647     description: |
63648       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
63649       ###### Related Nodes
63650       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
63651     required:
63652     - vig-address-type
63653     properties:
63654       vig-address-type:
63655         type: string
63656         description: indicates whether the VIG is for AVPN or INTERNET
63657       ipaddress-v4-vig:
63658         type: string
63659         description: v4 IP of the vig server
63660       ipaddress-v6-vig:
63661         type: string
63662         description: v6 IP of the vig server
63663   vig-servers:
63664     properties:
63665       vig-server:
63666         type: array
63667         items:
63668           $ref: "#/patchDefinitions/vig-server"
63669   vip-ipv4-address-list:
63670     description: |
63671       IPv4 Address Range
63672       ###### Related Nodes
63673       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63674       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63675       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
63676       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
63677     required:
63678     - vip-ipv4-address
63679     properties:
63680       vip-ipv4-address:
63681         type: string
63682         description: IP address
63683       vip-ipv4-prefix-length:
63684         type: integer
63685         format: int64
63686         description: Prefix length, 32 for single address
63687       vlan-id-inner:
63688         type: integer
63689         format: int64
63690         description: Inner VLAN tag
63691       vlan-id-outer:
63692         type: integer
63693         format: int64
63694         description: Outer VLAN tag
63695       is-floating:
63696         type: boolean
63697         description: Indicator of fixed or floating address
63698   vip-ipv6-address-list:
63699     description: |
63700       IPv6 Address Range
63701       ###### Related Nodes
63702       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63703       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63704       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
63705       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
63706     required:
63707     - vip-ipv6-address
63708     properties:
63709       vip-ipv6-address:
63710         type: string
63711         description: IP address
63712       vip-ipv6-prefix-length:
63713         type: integer
63714         format: int64
63715         description: Prefix length, 128 for single address
63716       vlan-id-inner:
63717         type: integer
63718         format: int64
63719         description: Inner VLAN tag
63720       vlan-id-outer:
63721         type: integer
63722         format: int64
63723         description: Outer VLAN tag
63724       is-floating:
63725         type: boolean
63726         description: Indicator of fixed or floating address
63727   virtual-data-center:
63728     description: |
63729       Virtual organization of cloud infrastructure elements in a data center context
63730       ###### Related Nodes
63731       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
63732       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
63733       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
63734     required:
63735     - vdc-id
63736     - vdc-name
63737     properties:
63738       vdc-id:
63739         type: string
63740         description: Unique ID of the vdc
63741       vdc-name:
63742         type: string
63743         description: Name of the virtual data center
63744   virtual-data-centers:
63745     description: |
63746       Virtual organization of cloud infrastructure elements in a data center context
63747     properties:
63748       virtual-data-center:
63749         type: array
63750         items:
63751           $ref: "#/patchDefinitions/virtual-data-center"
63752   vlan:
63753     description: |
63754       Definition of vlan
63755       ###### Related Nodes
63756       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
63757       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
63758       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
63759       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
63760       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
63761       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
63762       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
63763       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
63764       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
63765     required:
63766     - vlan-interface
63767     - in-maint
63768     - is-ip-unnumbered
63769     properties:
63770       vlan-interface:
63771         type: string
63772         description: String that identifies the interface
63773       vlan-id-inner:
63774         type: integer
63775         format: int64
63776         description: Inner VLAN tag
63777       vlan-id-outer:
63778         type: integer
63779         format: int64
63780         description: Outer VLAN tag
63781   vlans:
63782     properties:
63783       vlan:
63784         type: array
63785         items:
63786           $ref: "#/patchDefinitions/vlan"
63787   vnf:
63788     description: |
63789       Abstract vnf class
63790     required:
63791     - vnf-id
63792     properties:
63793       vnf-id:
63794         type: string
63795         description: Unique id of VNF.  This is unique across the graph.
63796   vnf-image:
63797     description: |
63798       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
63799       ###### Related Nodes
63800       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
63801       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
63802     required:
63803     - vnf-image-uuid
63804     - application
63805     - application-vendor
63806     properties:
63807       vnf-image-uuid:
63808         type: string
63809         description: Unique ID of this asset
63810       application:
63811         type: string
63812         description: The application that the image instantiates.
63813       application-vendor:
63814         type: string
63815         description: The vendor of the application.
63816       application-version:
63817         type: string
63818         description: The version of the application.
63819       selflink:
63820         type: string
63821         description: URL to endpoint where AAI can get more details
63822   vnf-images:
63823     description: |
63824       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
63825     properties:
63826       vnf-image:
63827         type: array
63828         items:
63829           $ref: "#/patchDefinitions/vnf-image"
63830   vnfc:
63831     description: |
63832       ###### Related Nodes
63833       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63834       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63835       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
63836       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
63837       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
63838       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
63839       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
63840       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
63841       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
63842     required:
63843     - vnfc-name
63844     - nfc-naming-code
63845     - nfc-function
63846     - in-maint
63847     - is-closed-loop-disabled
63848     properties:
63849       vnfc-name:
63850         type: string
63851         description: Unique ID of vnfc.
63852       nfc-naming-code:
63853         type: string
63854         description: Short code that is used in naming instances of the item being modeled
63855       nfc-function:
63856         type: string
63857         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
63858       prov-status:
63859         type: string
63860         description: prov status of this vnfc
63861       orchestration-status:
63862         type: string
63863         description: Orchestration status of this VNF, mastered by APP-C
63864       ipaddress-v4-oam-vip:
63865         type: string
63866         description: Oam V4 vip address of this vnfc
63867       in-maint:
63868         type: boolean
63869       is-closed-loop-disabled:
63870         type: boolean
63871       group-notation:
63872         type: string
63873         description: Group notation of VNFC
63874       model-invariant-id:
63875         type: string
63876         description: the ASDC model id for this resource or service model.
63877       model-version-id:
63878         type: string
63879         description: the ASDC model version for this resource or service model.
63880   vnfcs:
63881     description: |
63882       virtual network components associated with a vserver from application controller.
63883     properties:
63884       vnfc:
63885         type: array
63886         items:
63887           $ref: "#/patchDefinitions/vnfc"
63888   volume:
63889     description: |
63890       Ephemeral Block storage volume.
63891       ###### Related Nodes
63892       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
63893     required:
63894     - volume-id
63895     - volume-selflink
63896     properties:
63897       volume-id:
63898         type: string
63899         description: Unique ID of block storage volume relative to the vserver.
63900       volume-selflink:
63901         type: string
63902         description: URL to endpoint where AAI can get more details
63903   volume-group:
63904     description: |
63905       Persistent block-level storage.
63906       ###### Related Nodes
63907       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63908       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63909       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
63910       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
63911       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
63912     required:
63913     - volume-group-id
63914     - volume-group-name
63915     - vnf-type
63916     properties:
63917       volume-group-id:
63918         type: string
63919         description: Unique ID of volume-group.
63920       volume-group-name:
63921         type: string
63922         description: Name of the volume group.
63923       heat-stack-id:
63924         type: string
63925         description: Heat stack id corresponding to this volume-group
63926       vnf-type:
63927         type: string
63928         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.
63929       orchestration-status:
63930         type: string
63931         description: Orchestration status of this volume-group
63932       model-customization-id:
63933         type: string
63934         description: captures the id of all the configuration used to customize the resource for the service.
63935       vf-module-model-customization-id:
63936         type: string
63937         description: helps relate the volume group to the vf-module whose components will require the volume group
63938   volume-groups:
63939     description: |
63940       Collection of persistent block-level storage.
63941     properties:
63942       volume-group:
63943         type: array
63944         items:
63945           $ref: "#/patchDefinitions/volume-group"
63946   volumes:
63947     description: |
63948       Collection of ephemeral Block storage volumes.
63949     properties:
63950       volume:
63951         type: array
63952         items:
63953           $ref: "#/patchDefinitions/volume"
63954   vpls-pe:
63955     description: |
63956       VPLS Provider Edge routers.
63957       ###### Related Nodes
63958       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63959       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
63960       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
63961       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
63962       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
63963     required:
63964     - equipment-name
63965     properties:
63966       equipment-name:
63967         type: string
63968       prov-status:
63969         type: string
63970         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
63971       ipv4-oam-address:
63972         type: string
63973         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).
63974       equipment-role:
63975         type: string
63976         description: Client should send valid enumerated value, e.g., VPLS-PE.
63977       vlan-id-outer:
63978         type: integer
63979         format: int64
63980         description: Temporary location for stag to get to VCE
63981   vpls-pes:
63982     description: |
63983       Collection of VPLS Provider Edge routers
63984     properties:
63985       vpls-pe:
63986         type: array
63987         items:
63988           $ref: "#/patchDefinitions/vpls-pe"
63989   vpn-binding:
63990     description: |
63991       VPN binding
63992       ###### Related Nodes
63993       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
63994       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
63995       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
63996       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
63997       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
63998       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
63999     required:
64000     - vpn-id
64001     - vpn-name
64002     properties:
64003       vpn-id:
64004         type: string
64005         description: VPN ID, globally unique within A&AI
64006       vpn-name:
64007         type: string
64008         description: VPN Name
64009       vpn-platform:
64010         type: string
64011         description: the platform associated with the VPN example AVPN, Mobility
64012       vpn-type:
64013         type: string
64014         description: Type of the vpn, should be taken from enumerated/valid values
64015       vpn-region:
64016         type: string
64017         description: region of customer vpn
64018       customer-vpn-id:
64019         type: string
64020         description: id for this customer vpn
64021       route-distinguisher:
64022         type: string
64023         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
64024   vpn-bindings:
64025     properties:
64026       vpn-binding:
64027         type: array
64028         items:
64029           $ref: "#/patchDefinitions/vpn-binding"
64030   vserver:
64031     description: |
64032       Virtual Servers, aka virtual machine or VM.
64033       ###### Related Nodes
64034       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
64035       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
64036       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
64037       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
64038       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
64039       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
64040       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
64041       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
64042       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
64043       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
64044       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
64045       - VSERVER is DELETED when these are DELETED L-INTERFACE
64046       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
64047     required:
64048     - vserver-id
64049     - vserver-name
64050     - vserver-selflink
64051     - in-maint
64052     - is-closed-loop-disabled
64053     properties:
64054       vserver-id:
64055         type: string
64056         description: Unique identifier for this vserver relative to its tenant
64057       vserver-name:
64058         type: string
64059         description: Name of vserver
64060       vserver-name2:
64061         type: string
64062         description: Alternative name of vserver
64063       prov-status:
64064         type: string
64065         description: Trigger for operational monitoring of this resource by Service Assurance systems.
64066       vserver-selflink:
64067         type: string
64068         description: URL to endpoint where AAI can get more details
64069       in-maint:
64070         type: boolean
64071       is-closed-loop-disabled:
64072         type: boolean
64073   vservers:
64074     description: |
64075       Collection of virtual Servers, aka virtual machines or VMs.
64076     properties:
64077       vserver:
64078         type: array
64079         items:
64080           $ref: "#/patchDefinitions/vserver"
64081   zone:
64082     description: |
64083       A zone is a grouping of assets in a location homing to the same connections into the CBB
64084       ###### Related Nodes
64085       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64086       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64087       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64088       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64089       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64090     required:
64091     - zone-id
64092     - zone-name
64093     - design-type
64094     - zone-context
64095     properties:
64096       zone-id:
64097         type: string
64098         description: Code assigned by AIC to the zone
64099       zone-name:
64100         type: string
64101         description: English name associated with the zone
64102       design-type:
64103         type: string
64104         description: Design of zone [Medium/Large…]
64105       zone-context:
64106         type: string
64107         description: Context of zone [production/test]
64108       status:
64109         type: string
64110         description: Status of a zone.
64111   zones:
64112     description: |
64113       Collection of zones
64114     properties:
64115       zone:
64116         type: array
64117         items:
64118           $ref: "#/patchDefinitions/zone"
64119 getDefinitions:
64120   aai-internal:
64121     properties:
64122       property-name:
64123         type: string
64124       property-value:
64125         type: string
64126   action:
64127     properties:
64128       action-type:
64129         type: string
64130       action-data:
64131         type: array
64132         items:
64133           $ref: "#/getDefinitions/action-data"
64134   action-data:
64135     properties:
64136       property-name:
64137         type: string
64138       property-value:
64139         type: string
64140   actions:
64141     description: |
64142       APIs that are more action related than REST (e.g., notify, update).
64143     properties:
64144       update:
64145         type: object
64146         $ref: "#/getDefinitions/update"
64147       notify:
64148         type: object
64149         $ref: "#/getDefinitions/notify"
64150   allotted-resource:
64151     description: |
64152       Represents a slice or partial piece of a resource that gets separately allotted
64153       ###### Related Nodes
64154       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
64155       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
64156       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64157       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
64158       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
64159       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
64160       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
64161       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
64162       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
64163       - TO model-ver( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
64164       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
64165       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
64166       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
64167       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
64168       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
64169     required:
64170     - id
64171     properties:
64172       id:
64173         type: string
64174         description: Allotted Resource id UUID assigned to this instance.
64175       description:
64176         type: string
64177         description: The descriptive information assigned to this allotted resource instance
64178       selflink:
64179         type: string
64180         description: Link back to more information in the controller
64181       model-invariant-id:
64182         type: string
64183         description: the ASDC model id for this resource or service model.
64184       model-version-id:
64185         type: string
64186         description: the ASDC model version for this resource or service model.
64187       persona-model-version:
64188         type: string
64189         description: the ASDC model version for this resource or service model.
64190       resource-version:
64191         type: string
64192         description: Concurrency value
64193       orchestration-status:
64194         type: string
64195         description: Orchestration status
64196       operational-status:
64197         type: string
64198         description: Indicator for whether the resource is considered operational
64199       type:
64200         type: string
64201         description: Generic description of the type of allotted resource.
64202       role:
64203         type: string
64204         description: role in the network that this resource will be providing.
64205       tunnel-xconnects:
64206         type: array
64207         items:
64208           $ref: "#/getDefinitions/tunnel-xconnect"
64209       relationship-list:
64210         type: array
64211         items:
64212           $ref: "#/getDefinitions/relationship"
64213   allotted-resources:
64214     description: |
64215       This object is used to store slices of services being offered
64216     properties:
64217       allotted-resource:
64218         type: array
64219         items:
64220           $ref: "#/getDefinitions/allotted-resource"
64221   availability-zone:
64222     description: |
64223       Availability zone, a collection of compute hosts/pservers
64224       ###### Related Nodes
64225       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64226       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
64227       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64228       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
64229       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
64230       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
64231       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
64232       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
64233       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
64234     required:
64235     - availability-zone-name
64236     - hypervisor-type
64237     properties:
64238       availability-zone-name:
64239         type: string
64240         description: Name of the availability zone.  Unique across a cloud region
64241       hypervisor-type:
64242         type: string
64243         description: Type of hypervisor.  Source of truth should define valid values.
64244       operational-status:
64245         type: string
64246         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
64247       resource-version:
64248         type: string
64249         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64250       relationship-list:
64251         type: array
64252         items:
64253           $ref: "#/getDefinitions/relationship"
64254   availability-zones:
64255     description: |
64256       Collection of availability zones
64257     properties:
64258       availability-zone:
64259         type: array
64260         items:
64261           $ref: "#/getDefinitions/availability-zone"
64262   az-and-dvs-switches:
64263     properties:
64264       dvs-switches:
64265         type: object
64266         $ref: "#/getDefinitions/dvs-switches"
64267       availability-zone:
64268         type: object
64269         $ref: "#/getDefinitions/availability-zone"
64270   business:
64271     description: |
64272       Namespace for business related constructs
64273     properties:
64274       connectors:
64275         type: array
64276         items:
64277           $ref: "#/getDefinitions/connector"
64278       customers:
64279         type: array
64280         items:
64281           $ref: "#/getDefinitions/customer"
64282       lines-of-business:
64283         type: array
64284         items:
64285           $ref: "#/getDefinitions/line-of-business"
64286       owning-entities:
64287         type: array
64288         items:
64289           $ref: "#/getDefinitions/owning-entity"
64290       platforms:
64291         type: array
64292         items:
64293           $ref: "#/getDefinitions/platform"
64294       projects:
64295         type: array
64296         items:
64297           $ref: "#/getDefinitions/project"
64298   class-of-service:
64299     description: |
64300       ###### Related Nodes
64301       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
64302     required:
64303     - cos
64304     properties:
64305       cos:
64306         type: string
64307         description: unique identifier of probe
64308       probe-id:
64309         type: string
64310         description: identifier of probe
64311       probe-type:
64312         type: string
64313         description: type of probe
64314       resource-version:
64315         type: string
64316         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64317       relationship-list:
64318         type: array
64319         items:
64320           $ref: "#/getDefinitions/relationship"
64321   classes-of-service:
64322     description: |
64323       class-of-service of probe
64324     properties:
64325       class-of-service:
64326         type: array
64327         items:
64328           $ref: "#/getDefinitions/class-of-service"
64329   cloud-infrastructure:
64330     description: |
64331       Namespace for cloud infrastructure.
64332     properties:
64333       complexes:
64334         type: array
64335         items:
64336           $ref: "#/getDefinitions/complex"
64337       cloud-regions:
64338         type: array
64339         items:
64340           $ref: "#/getDefinitions/cloud-region"
64341       network-profiles:
64342         type: array
64343         items:
64344           $ref: "#/getDefinitions/network-profile"
64345       pservers:
64346         type: array
64347         items:
64348           $ref: "#/getDefinitions/pserver"
64349       virtual-data-centers:
64350         type: array
64351         items:
64352           $ref: "#/getDefinitions/virtual-data-center"
64353       operational-environments:
64354         type: array
64355         items:
64356           $ref: "#/getDefinitions/operational-environment"
64357   cloud-region:
64358     description: |
64359       cloud-region designates an installation of a cloud cluster or region or instantiation.
64360       ###### Related Nodes
64361       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
64362       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64363       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64364       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
64365       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64366       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64367       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64368       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64369       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64370       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64371       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64372       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64373       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64374       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64375       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64376       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64377       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
64378       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
64379       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
64380       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
64381       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
64382     required:
64383     - cloud-owner
64384     - cloud-region-id
64385     - sriov-automation
64386     properties:
64387       cloud-owner:
64388         type: string
64389         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
64390       cloud-region-id:
64391         type: string
64392         description: Identifier used by the vendor for the region. Second part of composite key
64393       cloud-type:
64394         type: string
64395         description: Type of the cloud (e.g., openstack)
64396       owner-defined-type:
64397         type: string
64398         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
64399       cloud-region-version:
64400         type: string
64401         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
64402       identity-url:
64403         type: string
64404         description: URL of the keystone identity service
64405       cloud-zone:
64406         type: string
64407         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
64408       complex-name:
64409         type: string
64410         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
64411       sriov-automation:
64412         type: boolean
64413       cloud-extra-info:
64414         type: string
64415         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
64416       cloud-epa-caps:
64417         type: string
64418         description: MultiVIM will discover and expose EPA capabilities.
64419       resource-version:
64420         type: string
64421         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64422       volume-groups:
64423         type: array
64424         items:
64425           $ref: "#/getDefinitions/volume-group"
64426       tenants:
64427         type: array
64428         items:
64429           $ref: "#/getDefinitions/tenant"
64430       flavors:
64431         type: array
64432         items:
64433           $ref: "#/getDefinitions/flavor"
64434       group-assignments:
64435         type: array
64436         items:
64437           $ref: "#/getDefinitions/group-assignment"
64438       snapshots:
64439         type: array
64440         items:
64441           $ref: "#/getDefinitions/snapshot"
64442       images:
64443         type: array
64444         items:
64445           $ref: "#/getDefinitions/image"
64446       dvs-switches:
64447         type: array
64448         items:
64449           $ref: "#/getDefinitions/dvs-switch"
64450       oam-networks:
64451         type: array
64452         items:
64453           $ref: "#/getDefinitions/oam-network"
64454       availability-zones:
64455         type: array
64456         items:
64457           $ref: "#/getDefinitions/availability-zone"
64458       relationship-list:
64459         type: array
64460         items:
64461           $ref: "#/getDefinitions/relationship"
64462       vip-ipv4-address-list:
64463         type: array
64464         items:
64465           $ref: "#/getDefinitions/vip-ipv4-address-list"
64466       vip-ipv6-address-list:
64467         type: array
64468         items:
64469           $ref: "#/getDefinitions/vip-ipv6-address-list"
64470       hpa-capabilities:
64471         type: array
64472         items:
64473           $ref: "#/getDefinitions/hpa-capability"
64474         description: List of cloud-region specific HPA Capabilities
64475   cloud-regions:
64476     properties:
64477       cloud-region:
64478         type: array
64479         items:
64480           $ref: "#/getDefinitions/cloud-region"
64481   complex:
64482     description: |
64483       Collection of physical locations that can house cloud-regions.
64484       ###### Related Nodes
64485       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64486       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64487       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64488       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
64489       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
64490       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
64491       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64492       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64493       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
64494       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64495       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64496       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
64497       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
64498       - COMPLEX is DELETED when these are DELETED CTAG-POOL
64499     required:
64500     - physical-location-id
64501     - physical-location-type
64502     - street1
64503     - city
64504     - postal-code
64505     - country
64506     - region
64507     properties:
64508       physical-location-id:
64509         type: string
64510         description: Unique identifier for physical location, e.g., CLLI
64511       data-center-code:
64512         type: string
64513         description: Data center code which can be an alternate way to identify a complex
64514       complex-name:
64515         type: string
64516         description: Gamma complex name for LCP instance.
64517       identity-url:
64518         type: string
64519         description: URL of the keystone identity service
64520       resource-version:
64521         type: string
64522         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64523       physical-location-type:
64524         type: string
64525         description: Type, e.g., central office, data center.
64526       street1:
64527         type: string
64528       street2:
64529         type: string
64530       city:
64531         type: string
64532       state:
64533         type: string
64534       postal-code:
64535         type: string
64536       country:
64537         type: string
64538       region:
64539         type: string
64540       latitude:
64541         type: string
64542       longitude:
64543         type: string
64544       elevation:
64545         type: string
64546       lata:
64547         type: string
64548       ctag-pools:
64549         type: array
64550         items:
64551           $ref: "#/getDefinitions/ctag-pool"
64552       relationship-list:
64553         type: array
64554         items:
64555           $ref: "#/getDefinitions/relationship"
64556   complexes:
64557     description: |
64558       Collection of physical locations that can house cloud-regions.
64559     properties:
64560       complex:
64561         type: array
64562         items:
64563           $ref: "#/getDefinitions/complex"
64564   configuration:
64565     description: |
64566       Port Mirror Configuration.
64567       ###### Related Nodes
64568       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
64569       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
64570       - TO l-interface( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
64571       - TO pnf( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
64572       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
64573       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
64574       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
64575       - FROM forwarder( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
64576       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
64577       - FROM evc( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
64578       - FROM forwarder-evc( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
64579       - CONFIGURATION is DELETED when these are DELETED METADATUM,EVC,FORWARDER-EVC
64580       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
64581     required:
64582     - configuration-id
64583     - configuration-type
64584     - configuration-sub-type
64585     - orchestration-status
64586     - operational-status
64587     - configuration-selflink
64588     - model-customization-id
64589     properties:
64590       configuration-id:
64591         type: string
64592         description: UUID assigned to configuration.
64593       management-option:
64594         type: string
64595         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
64596       configuration-name:
64597         type: string
64598         description: Name of the configuration.
64599       configuration-type:
64600         type: string
64601         description: port-mirroring-configuration.
64602       configuration-sub-type:
64603         type: string
64604         description: vprobe, pprobe.
64605       model-invariant-id:
64606         type: string
64607         description: the ASDC model id for this resource or service model.
64608       model-version-id:
64609         type: string
64610         description: the ASDC model version for this resource or service model.
64611       orchestration-status:
64612         type: string
64613         description: Orchestration status of the configuration.
64614       operational-status:
64615         type: string
64616         description: Indicator for whether the resource is considered operational.
64617       configuration-selflink:
64618         type: string
64619         description: URL to endpoint where AAI can get more details from SDN-GC.
64620       model-customization-id:
64621         type: string
64622         description: id of  the configuration used to customize the resource
64623       tunnel-bandwidth:
64624         type: string
64625         description: DHV Site Effective Bandwidth
64626       vendor-allowed-max-bandwidth:
64627         type: string
64628         description: Velocloud Nominal Throughput - VNT
64629       resource-version:
64630         type: string
64631         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64632       relationship-list:
64633         type: array
64634         items:
64635           $ref: "#/getDefinitions/relationship"
64636       metadata:
64637         type: array
64638         items:
64639           $ref: "#/getDefinitions/metadatum"
64640       forwarder-evcs:
64641         type: array
64642         items:
64643           $ref: "#/getDefinitions/forwarder-evc"
64644       evcs:
64645         type: array
64646         items:
64647           $ref: "#/getDefinitions/evc"
64648   configurations:
64649     description: |
64650       Collection of configurations
64651     properties:
64652       configuration:
64653         type: array
64654         items:
64655           $ref: "#/getDefinitions/configuration"
64656   connector:
64657     description: |
64658       Collection of resource instances used to connect a variety of disparate inventory widgets
64659       ###### Related Nodes
64660       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64661       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
64662       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
64663       - CONNECTOR is DELETED when these are DELETED METADATUM
64664     required:
64665     - resource-instance-id
64666     properties:
64667       resource-instance-id:
64668         type: string
64669         description: Unique id of resource instance.
64670       resource-version:
64671         type: string
64672         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64673       model-invariant-id:
64674         type: string
64675         description: the ASDC model id for this resource or service model.
64676       model-version-id:
64677         type: string
64678         description: the ASDC model version for this resource or service model.
64679       persona-model-version:
64680         type: string
64681         description: the ASDC model version for this resource or service model.
64682       widget-model-id:
64683         type: string
64684         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
64685       widget-model-version:
64686         type: string
64687         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
64688       relationship-list:
64689         type: array
64690         items:
64691           $ref: "#/getDefinitions/relationship"
64692       metadata:
64693         type: array
64694         items:
64695           $ref: "#/getDefinitions/metadatum"
64696   connectors:
64697     description: |
64698       Collection of resource instances used to connect a variety of disparate inventory widgets
64699     properties:
64700       connector:
64701         type: array
64702         items:
64703           $ref: "#/getDefinitions/connector"
64704   constrained-element-set:
64705     description: |
64706       This is how we would capture constraints defining allowed sets of elements.
64707       ###### Related Nodes
64708       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
64709       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64710       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
64711       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
64712     required:
64713     - constrained-element-set-uuid
64714     - constraint-type
64715     - check-type
64716     properties:
64717       constrained-element-set-uuid:
64718         type: string
64719       constraint-type:
64720         type: string
64721       check-type:
64722         type: string
64723       resource-version:
64724         type: string
64725       element-choice-sets:
64726         type: array
64727         items:
64728           $ref: "#/getDefinitions/element-choice-set"
64729       relationship-list:
64730         type: array
64731         items:
64732           $ref: "#/getDefinitions/relationship"
64733   constrained-element-sets:
64734     properties:
64735       constrained-element-set:
64736         type: array
64737         items:
64738           $ref: "#/getDefinitions/constrained-element-set"
64739   ctag-assignment:
64740     description: |
64741       ###### Related Nodes
64742       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64743       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
64744     required:
64745     - vlan-id-inner
64746     properties:
64747       vlan-id-inner:
64748         type: integer
64749         format: int64
64750         description: id.
64751       resource-version:
64752         type: string
64753         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64754       relationship-list:
64755         type: array
64756         items:
64757           $ref: "#/getDefinitions/relationship"
64758   ctag-assignments:
64759     properties:
64760       ctag-assignment:
64761         type: array
64762         items:
64763           $ref: "#/getDefinitions/ctag-assignment"
64764   ctag-pool:
64765     description: |
64766       A collection of C tags (vlan tags) grouped for a specific purpose.
64767       ###### Related Nodes
64768       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
64769       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
64770       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
64771       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
64772     required:
64773     - target-pe
64774     - availability-zone-name
64775     - ctag-pool-purpose
64776     properties:
64777       target-pe:
64778         type: string
64779         description: The Target provider edge router
64780       availability-zone-name:
64781         type: string
64782         description: Name of the availability zone
64783       ctag-pool-purpose:
64784         type: string
64785         description: Describes what the intended purpose of this pool is.
64786       ctag-values:
64787         type: string
64788         description: Comma separated list of ctags
64789       resource-version:
64790         type: string
64791         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64792       relationship-list:
64793         type: array
64794         items:
64795           $ref: "#/getDefinitions/relationship"
64796   ctag-pools:
64797     properties:
64798       ctag-pool:
64799         type: array
64800         items:
64801           $ref: "#/getDefinitions/ctag-pool"
64802   customer:
64803     description: |
64804       customer identifiers to provide linkage back to BSS information.
64805       ###### Related Nodes
64806       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
64807       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
64808     required:
64809     - global-customer-id
64810     - subscriber-name
64811     - subscriber-type
64812     properties:
64813       global-customer-id:
64814         type: string
64815         description: Global customer id used across ECOMP to uniquely identify customer.
64816       subscriber-name:
64817         type: string
64818         description: Subscriber name, an alternate way to retrieve a customer.
64819       subscriber-type:
64820         type: string
64821         description: Subscriber type, a way to provide VID with only the INFRA customers.
64822       resource-version:
64823         type: string
64824         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64825       service-subscriptions:
64826         type: array
64827         items:
64828           $ref: "#/getDefinitions/service-subscription"
64829       relationship-list:
64830         type: array
64831         items:
64832           $ref: "#/getDefinitions/relationship"
64833   customers:
64834     description: |
64835       Collection of customer identifiers to provide linkage back to BSS information.
64836     properties:
64837       customer:
64838         type: array
64839         items:
64840           $ref: "#/getDefinitions/customer"
64841   cvlan-tag-entry:
64842     required:
64843     - cvlan-tag
64844     properties:
64845       cvlan-tag:
64846         type: integer
64847         format: int64
64848         description: See mis-na-virtualization-platform.yang
64849       resource-version:
64850         type: string
64851         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64852       relationship-list:
64853         type: array
64854         items:
64855           $ref: "#/getDefinitions/relationship"
64856   cvlan-tags:
64857     properties:
64858       cvlan-tag-entry:
64859         type: array
64860         items:
64861           $ref: "#/getDefinitions/cvlan-tag-entry"
64862   dvs-switch:
64863     description: |
64864       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.
64865       ###### Related Nodes
64866       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
64867       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
64868     required:
64869     - switch-name
64870     - vcenter-url
64871     properties:
64872       switch-name:
64873         type: string
64874         description: DVS switch name
64875       vcenter-url:
64876         type: string
64877         description: URL used to reach the vcenter
64878       resource-version:
64879         type: string
64880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64881       relationship-list:
64882         type: array
64883         items:
64884           $ref: "#/getDefinitions/relationship"
64885   dvs-switches:
64886     description: |
64887       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
64888     properties:
64889       dvs-switch:
64890         type: array
64891         items:
64892           $ref: "#/getDefinitions/dvs-switch"
64893   edge-prop-names:
64894     description: |
64895       Internal map to define the properties of an edge and interpret the map EdgeRules
64896     properties:
64897       edgeLabel:
64898         type: string
64899       direction:
64900         type: string
64901       multiplicityRule:
64902         type: string
64903       contains-other-v:
64904         type: string
64905       delete-other-v:
64906         type: string
64907       SVC-INFRA:
64908         type: string
64909       prevent-delete:
64910         type: string
64911       aai-uuid:
64912         type: string
64913   edge-tag-query-request:
64914     properties:
64915       edge-tag:
64916         type: string
64917       result-detail:
64918         type: string
64919       start-node-type:
64920         type: string
64921       start-node-filter:
64922         type: array
64923         items:
64924           $ref: "#/getDefinitions/start-node-filter"
64925       include-node-filter:
64926         type: array
64927         items:
64928           $ref: "#/getDefinitions/include-node-filter"
64929       secondary-filter:
64930         type: array
64931         items:
64932           $ref: "#/getDefinitions/secondary-filter"
64933   edge-tag-query-result:
64934     properties:
64935       tagged-inventory-item-list:
64936         type: array
64937         items:
64938           $ref: "#/getDefinitions/tagged-inventory-item-list"
64939   element-choice-set:
64940     description: |
64941       This is how we would capture constraints defining allowed sets of elements.
64942       ###### Related Nodes
64943       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
64944       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
64945       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
64946     required:
64947     - element-choice-set-uuid
64948     - element-choice-set-name
64949     properties:
64950       element-choice-set-uuid:
64951         type: string
64952       element-choice-set-name:
64953         type: string
64954       cardinality:
64955         type: string
64956       resource-version:
64957         type: string
64958       model-elements:
64959         type: array
64960         items:
64961           $ref: "#/getDefinitions/model-element"
64962       relationship-list:
64963         type: array
64964         items:
64965           $ref: "#/getDefinitions/relationship"
64966   element-choice-sets:
64967     properties:
64968       element-choice-set:
64969         type: array
64970         items:
64971           $ref: "#/getDefinitions/element-choice-set"
64972   entitlement:
64973     description: |
64974       Metadata for entitlement group.
64975       ###### Related Nodes
64976       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64977       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
64978     required:
64979     - group-uuid
64980     - resource-uuid
64981     properties:
64982       group-uuid:
64983         type: string
64984         description: Unique ID for the entitlement group the resource comes from, should be uuid.
64985       resource-uuid:
64986         type: string
64987         description: Unique ID of an entitlement resource.
64988       resource-version:
64989         type: string
64990         description: Concurrency value
64991       relationship-list:
64992         type: array
64993         items:
64994           $ref: "#/getDefinitions/relationship"
64995   entitlements:
64996     description: |
64997       Entitlements, keyed by group-uuid and resource-uuid, related to license management
64998     properties:
64999       entitlement:
65000         type: array
65001         items:
65002           $ref: "#/getDefinitions/entitlement"
65003   esr-ems:
65004     description: |
65005       Persist EMS address information used by EMS driver.
65006       ###### Related Nodes
65007       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
65008       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
65009     required:
65010     - ems-id
65011     properties:
65012       ems-id:
65013         type: string
65014         description: Unique ID of EMS.
65015       resource-version:
65016         type: string
65017         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65018       esr-system-info-list:
65019         type: object
65020         $ref: "#/getDefinitions/esr-system-info-list"
65021       relationship-list:
65022         type: object
65023         $ref: "#/getDefinitions/relationship-list"
65024   esr-ems-list:
65025     properties:
65026       esr-ems:
65027         type: array
65028         items:
65029           $ref: "#/getDefinitions/esr-ems"
65030   esr-system-info:
65031     description: |
65032       Persist common address information of external systems.
65033       ###### Related Nodes
65034       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
65035       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
65036       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
65037       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
65038     required:
65039     - esr-system-info-id
65040     - user-name
65041     - password
65042     - system-type
65043     properties:
65044       esr-system-info-id:
65045         type: string
65046         description: Unique ID of esr system info.
65047       system-name:
65048         type: string
65049         description: name of external system.
65050       type:
65051         type: string
65052         description: type of external systems.
65053       vendor:
65054         type: string
65055         description: vendor of external systems.
65056       version:
65057         type: string
65058         description: version of external systems.
65059       service-url:
65060         type: string
65061         description: url used to access external systems.
65062       user-name:
65063         type: string
65064         description: username used to access external systems.
65065       password:
65066         type: string
65067         description: password used to access external systems.
65068       system-type:
65069         type: string
65070         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
65071       protocol:
65072         type: string
65073         description: protocol of third party SDNC, for example netconf/snmp.
65074       ssl-cacert:
65075         type: string
65076         description: ca file content if enabled ssl on auth-url.
65077       ssl-insecure:
65078         type: boolean
65079         description: Whether to verify VIM's certificate.
65080       ip-address:
65081         type: string
65082         description: service IP of ftp server.
65083       port:
65084         type: string
65085         description: service port of ftp server.
65086       cloud-domain:
65087         type: string
65088         description: domain info for authentication.
65089       default-tenant:
65090         type: string
65091         description: default tenant of VIM.
65092       passive:
65093         type: boolean
65094         description: ftp passive mode or not.
65095       remote-path:
65096         type: string
65097         description: resource or performance data file path.
65098       system-status:
65099         type: string
65100         description: the status of external system.
65101       resource-version:
65102         type: string
65103         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65104       relationship-list:
65105         type: object
65106         $ref: "#/getDefinitions/relationship-list"
65107   esr-system-info-list:
65108     description: |
65109       Collection of persistent block-level external system auth info.
65110     properties:
65111       esr-system-info:
65112         type: array
65113         items:
65114           $ref: "#/getDefinitions/esr-system-info"
65115   esr-thirdparty-sdnc:
65116     description: |
65117       Persist SDNC address information used by ONAP SDNC.
65118       ###### Related Nodes
65119       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
65120       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
65121       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
65122     required:
65123     - thirdparty-sdnc-id
65124     properties:
65125       thirdparty-sdnc-id:
65126         type: string
65127         description: Unique ID of SDNC.
65128       location:
65129         type: string
65130         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
65131       product-name:
65132         type: string
65133         description: password used to access SDNC server.
65134       resource-version:
65135         type: string
65136         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65137       esr-system-info-list:
65138         type: object
65139         $ref: "#/getDefinitions/esr-system-info-list"
65140       relationship-list:
65141         type: object
65142         $ref: "#/getDefinitions/relationship-list"
65143   esr-thirdparty-sdnc-list:
65144     properties:
65145       esr-thirdparty-sdnc:
65146         type: array
65147         items:
65148           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
65149   esr-vnfm:
65150     description: |
65151       Persist VNFM address information used by VF-C.
65152       ###### Related Nodes
65153       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
65154       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
65155     required:
65156     - vnfm-id
65157     properties:
65158       vnfm-id:
65159         type: string
65160         description: Unique ID of VNFM.
65161       vim-id:
65162         type: string
65163         description: indecate the VIM to deploy VNF.
65164       certificate-url:
65165         type: string
65166         description: certificate url of VNFM.
65167       resource-version:
65168         type: string
65169         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65170       esr-system-info-list:
65171         type: object
65172         $ref: "#/getDefinitions/esr-system-info-list"
65173       relationship-list:
65174         type: object
65175         $ref: "#/getDefinitions/relationship-list"
65176   esr-vnfm-list:
65177     properties:
65178       esr-vnfm:
65179         type: array
65180         items:
65181           $ref: "#/getDefinitions/esr-vnfm"
65182   evc:
65183     description: |
65184       evc object is an optional child object of the Configuration object.
65185       ###### Related Nodes
65186       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
65187     required:
65188     - evc-id
65189     properties:
65190       evc-id:
65191         type: string
65192         description: Unique/key field for the evc object
65193       forwarding-path-topology:
65194         type: string
65195         description: Point-to-Point, Multi-Point
65196       cir-value:
65197         type: string
65198         description: Commited Information Rate
65199       cir-units:
65200         type: string
65201         description: CIR units
65202       connection-diversity-group-id:
65203         type: string
65204         description: Diversity Group ID
65205       service-hours:
65206         type: string
65207         description: formerly Performance Group
65208       esp-evc-circuit-id:
65209         type: string
65210         description: EVC Circuit ID of ESP EVC
65211       esp-evc-cir-value:
65212         type: string
65213         description: Committed Information Rate (For ESP)
65214       esp-evc-cir-units:
65215         type: string
65216         description: CIR units (For ESP)
65217       esp-itu-code:
65218         type: string
65219         description: Identifies ESP
65220       collector-pop-clli:
65221         type: string
65222         description: Collector POP CLLI (from the hostname of the access pnf)
65223       inter-connect-type-ingress:
65224         type: string
65225         description: Interconnect type on ingress side of EVC.
65226       tagmode-access-ingress:
65227         type: string
65228         description: tagode for collector side of EVC
65229       tagmode-access-egress:
65230         type: string
65231         description: tagMode for network side of EVC
65232       relationship-list:
65233         type: array
65234         items:
65235           $ref: "#/getDefinitions/relationship"
65236       resource-version:
65237         type: string
65238         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65239   evcs:
65240     properties:
65241       evc:
65242         type: array
65243         items:
65244           $ref: "#/getDefinitions/evc"
65245   external-system:
65246     description: |
65247       Namespace for external system.
65248     properties:
65249       esr-ems-list:
65250         type: object
65251         $ref: "#/getDefinitions/esr-ems-list"
65252       esr-vnfm-list:
65253         type: object
65254         $ref: "#/getDefinitions/esr-vnfm-list"
65255       esr-thirdparty-sdnc-list:
65256         type: object
65257         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
65258   extra-properties:
65259     description: |
65260       Extra properties for inventory item for response list
65261     properties:
65262       extra-property:
65263         type: array
65264         items:
65265           $ref: "#/getDefinitions/extra-property"
65266   extra-property:
65267     properties:
65268       property-name:
65269         type: string
65270       property-value:
65271         type: string
65272   flavor:
65273     description: |
65274       Openstack flavor.
65275       ###### Related Nodes
65276       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65277       - FROM hpa-capability( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
65278       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
65279       - FLAVOR cannot be deleted if linked to HPA-CAPABILITY,VSERVER
65280     required:
65281     - flavor-id
65282     - flavor-name
65283     - flavor-selflink
65284     properties:
65285       flavor-id:
65286         type: string
65287         description: Flavor id, expected to be unique across cloud-region.
65288       flavor-name:
65289         type: string
65290         description: Cloud Region Flavor name
65291       flavor-vcpus:
65292         type: integer
65293         format: int32
65294         description: Number of CPUs
65295       flavor-ram:
65296         type: integer
65297         format: int32
65298         description: Amount of memory
65299       flavor-disk:
65300         type: integer
65301         format: int32
65302         description: Disk space
65303       flavor-ephemeral:
65304         type: integer
65305         format: int32
65306         description: Amount of ephemeral disk space
65307       flavor-swap:
65308         type: string
65309         description: amount of swap space allocation
65310       flavor-is-public:
65311         type: boolean
65312         description: whether flavor is available to all users or private to the tenant it was created in.
65313       flavor-selflink:
65314         type: string
65315         description: URL to endpoint where AAI can get more details
65316       flavor-disabled:
65317         type: boolean
65318         description: Boolean as to whether this flavor is no longer enabled
65319       hpa-capabilities:
65320         type: array
65321         items:
65322           $ref: "#/getDefinitions/hpa-capability"
65323         description: List of flavor specific HPA Capabilities
65324       resource-version:
65325         type: string
65326         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65327       relationship-list:
65328         type: array
65329         items:
65330           $ref: "#/getDefinitions/relationship"
65331   flavors:
65332     description: |
65333       Collection of openstack flavors.
65334     properties:
65335       flavor:
65336         type: array
65337         items:
65338           $ref: "#/getDefinitions/flavor"
65339   forwarder:
65340     description: |
65341       Entity describing a sequenced segment of forwarding path
65342       ###### Related Nodes
65343       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
65344       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
65345       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
65346       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
65347       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
65348       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
65349     required:
65350     - sequence
65351     properties:
65352       sequence:
65353         type: integer
65354         format: int32
65355         description: Unique ID of this segmentation
65356       forwarder-role:
65357         type: string
65358         description: ingress, intermediate, egress
65359       relationship-list:
65360         type: array
65361         items:
65362           $ref: "#/getDefinitions/relationship"
65363       resource-version:
65364         type: string
65365         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65366   forwarder-evc:
65367     description: |
65368       forwarder object is an optional child object of the Configuration object.
65369       ###### Related Nodes
65370       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
65371     required:
65372     - forwarder-evc-id
65373     properties:
65374       forwarder-evc-id:
65375         type: string
65376         description: Key for forwarder-evc object
65377       circuit-id:
65378         type: string
65379         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
65380       ivlan:
65381         type: string
65382         description: Internal VLAN.
65383       svlan:
65384         type: string
65385         description: SVLAN value for ingress of egress forwarder.
65386       cvlan:
65387         type: string
65388         description: CVLAN value for ingress of egress forwarder.
65389       relationship-list:
65390         type: array
65391         items:
65392           $ref: "#/getDefinitions/relationship"
65393       resource-version:
65394         type: string
65395         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65396   forwarder-evcs:
65397     properties:
65398       forwarder-evc:
65399         type: array
65400         items:
65401           $ref: "#/getDefinitions/forwarder-evc"
65402   forwarders:
65403     properties:
65404       forwarder:
65405         type: array
65406         items:
65407           $ref: "#/getDefinitions/forwarder"
65408   forwarding-path:
65409     description: |
65410       Entity that describes the sequenced forwarding path between interfaces of services or resources
65411       ###### Related Nodes
65412       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
65413       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
65414       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
65415       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
65416       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
65417     required:
65418     - forwarding-path-id
65419     - forwarding-path-name
65420     properties:
65421       forwarding-path-id:
65422         type: string
65423         description: Unique ID of this FP
65424       forwarding-path-name:
65425         type: string
65426         description: Name of the FP
65427       relationship-list:
65428         type: array
65429         items:
65430           $ref: "#/getDefinitions/relationship"
65431       resource-version:
65432         type: string
65433         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65434       selflink:
65435         type: string
65436         description: the self link for this FP
65437       forwarders:
65438         type: array
65439         items:
65440           $ref: "#/getDefinitions/forwarder"
65441   forwarding-paths:
65442     properties:
65443       forwarding-path:
65444         type: array
65445         items:
65446           $ref: "#/getDefinitions/forwarding-path"
65447   generic-vnf:
65448     description: |
65449       General purpose VNF
65450       ###### Related Nodes
65451       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
65452       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
65453       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
65454       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
65455       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65456       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
65457       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
65458       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
65459       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
65460       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
65461       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
65462       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
65463       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
65464       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
65465       - TO model-ver( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
65466       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
65467       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65468       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65469       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65470       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65471       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65472       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
65473       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
65474       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
65475       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
65476       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65477       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
65478       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65479       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
65480       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
65481     required:
65482     - vnf-id
65483     - vnf-instance-id
65484     - vnf-name
65485     - vnf-type
65486     - vnf-package-name
65487     - vnf-discriptor-name
65488     - job-id
65489     - in-maint
65490     - is-closed-loop-disabled
65491     properties:
65492       vnf-id:
65493         type: string
65494         description: Unique id of VNF.  This is unique across the graph.
65495       vnf-instance-id:
65496         type: string
65497         description: vnf instance id.
65498       vnf-name:
65499         type: string
65500         description: Name of VNF.
65501       vnf-name2:
65502         type: string
65503         description: Alternate name of VNF.
65504       vnf-type:
65505         type: string
65506         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.
65507       service-id:
65508         type: string
65509         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
65510       regional-resource-zone:
65511         type: string
65512         description: Regional way of organizing pservers, source of truth should define values
65513       prov-status:
65514         type: string
65515         description: Trigger for operational monitoring of this resource by Service Assurance systems.
65516       operational-status:
65517         type: string
65518         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
65519       license-key:
65520         type: string
65521         description: OBSOLETE -  do not use
65522       equipment-role:
65523         type: string
65524         description: Client should send valid enumerated value
65525       orchestration-status:
65526         type: string
65527         description: Orchestration status of this VNF, used by MSO.
65528       vnf-package-name:
65529         type: string
65530       vnf-discriptor-name:
65531         type: string
65532         description: vnf discriptor name
65533       job-id:
65534         type: string
65535         description: job id corresponding to vnf
65536       heat-stack-id:
65537         type: string
65538         description: Heat stack id corresponding to this instance, managed by MSO
65539       mso-catalog-key:
65540         type: string
65541         description: Corresponds to the SDN-C catalog id used to configure this VCE
65542       management-option:
65543         type: string
65544         description: identifier of managed by ATT or customer
65545       ipv4-oam-address:
65546         type: string
65547         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
65548       ipv4-loopback0-address:
65549         type: string
65550         description: v4 Loopback0 address
65551       nm-lan-v6-address:
65552         type: string
65553         description: v6 Loopback address
65554       management-v6-address:
65555         type: string
65556         description: v6 management address
65557       vcpu:
65558         type: integer
65559         format: int64
65560         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
65561       vcpu-units:
65562         type: string
65563         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
65564       vmemory:
65565         type: integer
65566         format: int64
65567         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
65568       vmemory-units:
65569         type: string
65570         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
65571       vdisk:
65572         type: integer
65573         format: int64
65574         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
65575       vdisk-units:
65576         type: string
65577         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
65578       nshd:
65579         type: integer
65580         format: int64
65581         description: number of associated SHD in vnf.
65582       nvm:
65583         type: integer
65584         format: int64
65585         description: number of vms in vnf.
65586       nnet:
65587         type: integer
65588         format: int64
65589         description: number of network in vnf.
65590       in-maint:
65591         type: boolean
65592       is-closed-loop-disabled:
65593         type: boolean
65594       resource-version:
65595         type: string
65596         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65597       summary-status:
65598         type: string
65599         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
65600       encrypted-access-flag:
65601         type: boolean
65602         description: indicates whether generic-vnf access uses SSH
65603       entitlement-assignment-group-uuid:
65604         type: string
65605         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
65606       entitlement-resource-uuid:
65607         type: string
65608         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
65609       license-assignment-group-uuid:
65610         type: string
65611         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
65612       license-key-uuid:
65613         type: string
65614         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
65615       model-invariant-id:
65616         type: string
65617         description: the ASDC model id for this resource or service model.
65618       model-version-id:
65619         type: string
65620         description: the ASDC model version for this resource or service model.
65621       persona-model-version:
65622         type: string
65623         description: the ASDC model version for this resource or service model.
65624       model-customization-id:
65625         type: string
65626         description: captures the id of all the configuration used to customize the resource for the service.
65627       widget-model-id:
65628         type: string
65629         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
65630       widget-model-version:
65631         type: string
65632         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
65633       as-number:
65634         type: string
65635         description: as-number of the VNF
65636       regional-resource-subzone:
65637         type: string
65638         description: represents sub zone of the rr plane
65639       nf-type:
65640         type: string
65641         description: Generic description of the type of NF
65642       nf-function:
65643         type: string
65644         description: English description of Network function that the specific VNF deployment is providing
65645       nf-role:
65646         type: string
65647         description: role in the network that this model will be providing
65648       nf-naming-code:
65649         type: string
65650         description: string assigned to this model used for naming purposes
65651       selflink:
65652         type: string
65653         description: Path to the controller object.
65654       ipv4-oam-gateway-address:
65655         type: string
65656         description: Gateway address
65657       ipv4-oam-gateway-address-prefix-length:
65658         type: integer
65659         format: int32
65660         description: Prefix length for oam-address
65661       vlan-id-outer:
65662         type: integer
65663         format: int64
65664         description: Temporary location for S-TAG to get to VCE
65665       nm-profile-name:
65666         type: string
65667         description: Network Management profile of this VNF
65668       relationship-list:
65669         type: array
65670         items:
65671           $ref: "#/getDefinitions/relationship"
65672       l-interfaces:
65673         type: array
65674         items:
65675           $ref: "#/getDefinitions/l-interface"
65676       lag-interfaces:
65677         type: array
65678         items:
65679           $ref: "#/getDefinitions/lag-interface"
65680       vf-modules:
65681         type: array
65682         items:
65683           $ref: "#/getDefinitions/vf-module"
65684       licenses:
65685         type: array
65686         items:
65687           $ref: "#/getDefinitions/license"
65688       entitlements:
65689         type: array
65690         items:
65691           $ref: "#/getDefinitions/entitlement"
65692   generic-vnfs:
65693     description: |
65694       Collection of VNFs
65695     properties:
65696       generic-vnf:
65697         type: array
65698         items:
65699           $ref: "#/getDefinitions/generic-vnf"
65700   group-assignment:
65701     description: |
65702       Openstack group-assignment used to store exclusivity groups (EG).
65703       ###### Related Nodes
65704       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65705       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
65706       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
65707     required:
65708     - group-id
65709     - group-type
65710     - group-name
65711     properties:
65712       group-id:
65713         type: string
65714         description: Group id, expected to be unique across cloud-region.
65715       group-type:
65716         type: string
65717         description: Group type - the type of group this instance refers to
65718       group-name:
65719         type: string
65720         description: Group name - name assigned to the group
65721       group-description:
65722         type: string
65723         description: Group description - description of the group
65724       resource-version:
65725         type: string
65726         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65727       relationship-list:
65728         type: array
65729         items:
65730           $ref: "#/getDefinitions/relationship"
65731   group-assignments:
65732     description: |
65733       Collection of openstack group assignments
65734     properties:
65735       group-assignment:
65736         type: array
65737         items:
65738           $ref: "#/getDefinitions/group-assignment"
65739   host-route:
65740     description: |
65741       ###### Related Nodes
65742       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
65743     required:
65744     - host-route-id
65745     - route-prefix
65746     - next-hop
65747     properties:
65748       host-route-id:
65749         type: string
65750         description: host-route id
65751       route-prefix:
65752         type: string
65753         description: subnet prefix
65754       next-hop:
65755         type: string
65756         description: Could be ip-address, hostname, or service-instance
65757       next-hop-type:
65758         type: string
65759         description: Should be ip-address, hostname, or service-instance to match next-hop
65760       resource-version:
65761         type: string
65762         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65763       relationship-list:
65764         type: array
65765         items:
65766           $ref: "#/getDefinitions/relationship"
65767   host-routes:
65768     properties:
65769       host-route:
65770         type: array
65771         items:
65772           $ref: "#/getDefinitions/host-route"
65773   hpa-capabilities:
65774     description: |
65775       Collection of HPA Capabilities
65776     properties:
65777       hpa-capability:
65778         type: array
65779         items:
65780           $ref: "#/getDefinitions/hpa-capability"
65781   hpa-capability:
65782     description: |
65783       Represents a HPA capability
65784       ###### Related Nodes
65785       - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
65786       - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65787       - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
65788       - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
65789     required:
65790     - hpa-capability-id
65791     - hpa-feature
65792     properties:
65793       hpa-capability-id:
65794         type: string
65795         description: UUID to uniquely identify a HPA capability
65796       hpa-feature:
65797         type: string
65798         description: Name of the HPACapability
65799       hpa-version:
65800         type: string
65801         description: HPA schema version
65802       hpa-hw-arch:
65803         type: string
65804         description: Hardware architecture
65805       resource-version:
65806         type: string
65807         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65808       relationship-list:
65809         type: array
65810         items:
65811           $ref: "#/getDefinitions/relationship"
65812       hpa-feature-attributes:
65813         type: array
65814         items:
65815           $ref: "#/getDefinitions/hpa-feature-attributes"
65816   hpa-feature-attributes:
65817     description: |
65818       HPA Capability Feature attributes
65819       ###### Related Nodes
65820       - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
65821     properties:
65822       hpa-attr-key:
65823         type: string
65824         description: name of the specific HPA attribute
65825       hpa-attr-value:
65826         type: string
65827         description: JSON string specifying the value, unit and type of the specific HPA attribute
65828       resource-version:
65829         type: string
65830         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65831       relationship-list:
65832         type: array
65833         items:
65834           $ref: "#/getDefinitions/relationship"
65835   image:
65836     description: |
65837       Openstack image.
65838       ###### Related Nodes
65839       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65840       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
65841       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
65842       - IMAGE cannot be deleted if linked to VSERVER
65843       - IMAGE is DELETED when these are DELETED METADATUM
65844     required:
65845     - image-id
65846     - image-name
65847     - image-os-distro
65848     - image-os-version
65849     - image-selflink
65850     properties:
65851       image-id:
65852         type: string
65853         description: Image id, expected to be unique across cloud region
65854       image-name:
65855         type: string
65856         description: Image name
65857       image-architecture:
65858         type: string
65859         description: Operating system architecture.
65860       image-os-distro:
65861         type: string
65862         description: The common name of the operating system distribution in lowercase
65863       image-os-version:
65864         type: string
65865         description: The operating system version as specified by the distributor.
65866       application:
65867         type: string
65868         description: The application that the image instantiates.
65869       application-vendor:
65870         type: string
65871         description: The vendor of the application.
65872       application-version:
65873         type: string
65874         description: The version of the application.
65875       image-selflink:
65876         type: string
65877         description: URL to endpoint where AAI can get more details
65878       resource-version:
65879         type: string
65880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65881       relationship-list:
65882         type: array
65883         items:
65884           $ref: "#/getDefinitions/relationship"
65885       metadata:
65886         type: array
65887         items:
65888           $ref: "#/getDefinitions/metadatum"
65889   images:
65890     description: |
65891       Collectio of Openstack images.
65892     properties:
65893       image:
65894         type: array
65895         items:
65896           $ref: "#/getDefinitions/image"
65897   include-node-filter:
65898     properties:
65899       include-node-type:
65900         type: string
65901   instance-filter:
65902     description: |
65903       InstanceFilter for performing a named-query or model query
65904   instance-filters:
65905     description: |
65906       InstanceFilters for performing a named-query or model query
65907     properties:
65908       instance-filter:
65909         type: array
65910         items:
65911           $ref: "#/getDefinitions/instance-filter"
65912   instance-group:
65913     description: |
65914       General mechanism for grouping instances
65915       ###### Related Nodes
65916       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
65917       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65918       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65919       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
65920       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
65921       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65922       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65923       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65924       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65925       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65926       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65927       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65928     required:
65929     - instance-group-role
65930     - model-invariant-id
65931     - model-version-id
65932     - id
65933     - description
65934     - type
65935     properties:
65936       instance-group-role:
65937         type: string
65938         description: role of the instance group.
65939       model-invariant-id:
65940         type: string
65941         description: ASDC model id for this resource or service model.
65942       model-version-id:
65943         type: string
65944         description: ASDC model version uid for this resource model.
65945       id:
65946         type: string
65947         description: Instance Group ID, UUID assigned to this instance.
65948       description:
65949         type: string
65950         description: Descriptive text to help identify the usage of this instance-group
65951       type:
65952         type: string
65953         description: Only valid value today is lower case ha for high availability
65954       sub-type:
65955         type: string
65956         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
65957       resource-version:
65958         type: string
65959         description: Concurrency value
65960       relationship-list:
65961         type: array
65962         items:
65963           $ref: "#/getDefinitions/relationship"
65964   instance-groups:
65965     description: |
65966       Collection of openstack route table references
65967     properties:
65968       instance-group:
65969         type: array
65970         items:
65971           $ref: "#/getDefinitions/instance-group"
65972   inventory:
65973     properties:
65974       search:
65975         type: object
65976         $ref: "#/getDefinitions/search"
65977       actions:
65978         type: object
65979         $ref: "#/getDefinitions/actions"
65980       cloud-infrastructure:
65981         type: object
65982         $ref: "#/getDefinitions/cloud-infrastructure"
65983       external-system:
65984         type: object
65985         $ref: "#/getDefinitions/external-system"
65986       business:
65987         type: object
65988         $ref: "#/getDefinitions/business"
65989       service-design-and-creation:
65990         type: object
65991         $ref: "#/getDefinitions/service-design-and-creation"
65992       network:
65993         type: object
65994         $ref: "#/getDefinitions/network"
65995       aai-internal:
65996         type: object
65997         $ref: "#/getDefinitions/aai-internal"
65998       nodes:
65999         type: array
66000         items:
66001           $ref: "#/getDefinitions/aai-internal"
66002   inventory-item:
66003     properties:
66004       inventory-item-type:
66005         type: string
66006       inventory-item-link:
66007         type: string
66008       inventory-item-data:
66009         type: array
66010         items:
66011           $ref: "#/getDefinitions/inventory-item-data"
66012       tagged-inventory-item-list:
66013         type: array
66014         items:
66015           $ref: "#/getDefinitions/tagged-inventory-item-list"
66016   inventory-item-data:
66017     properties:
66018       property-name:
66019         type: string
66020       property-value:
66021         type: string
66022   inventory-response-item:
66023     description: |
66024       Inventory item for response list
66025     properties:
66026       model-name:
66027         type: string
66028       extra-properties:
66029         type: object
66030         $ref: "#/getDefinitions/extra-properties"
66031       inventory-response-items:
66032         type: object
66033         $ref: "#/getDefinitions/inventory-response-items"
66034   inventory-response-items:
66035     description: |
66036       Container for inventory items in response list
66037     properties:
66038       inventory-response-item:
66039         type: array
66040         items:
66041           $ref: "#/getDefinitions/inventory-response-item"
66042   ipsec-configuration:
66043     description: |
66044       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
66045       ###### Related Nodes
66046       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
66047       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
66048       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
66049     required:
66050     - ipsec-configuration-id
66051     properties:
66052       ipsec-configuration-id:
66053         type: string
66054         description: UUID of this configuration
66055       requested-vig-address-type:
66056         type: string
66057         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
66058       requested-encryption-strength:
66059         type: string
66060         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
66061       requested-dmz-type:
66062         type: string
66063         description: ATT can offer a shared DMZ or a DMZ specific to a customer
66064       shared-dmz-network-address:
66065         type: string
66066         description: Network address of shared DMZ
66067       requested-customer-name:
66068         type: string
66069         description: If the DMZ is a custom DMZ, this field will indicate the customer information
66070       ike-version:
66071         type: string
66072         description: can be 1 or 2
66073       ikev1-authentication:
66074         type: string
66075         description: Contains values like md5, sha1, sha256, sha384
66076       ikev1-encryption:
66077         type: string
66078         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
66079       ikev1-dh-group:
66080         type: string
66081         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
66082       ikev1-am-group-id:
66083         type: string
66084         description: Group name defined in VIG for clients using aggressive mode
66085       ikev1-am-password:
66086         type: string
66087         description: pre-shared key for the above group name
66088       ikev1-sa-lifetime:
66089         type: string
66090         description: Lifetime for IKEv1 SA
66091       ipsec-authentication:
66092         type: string
66093         description: md5, sha1, sha256, sha384
66094       ipsec-encryption:
66095         type: string
66096         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
66097       ipsec-sa-lifetime:
66098         type: string
66099         description: Life time for IPSec SA
66100       ipsec-pfs:
66101         type: string
66102         description: enable PFS or not
66103       xauth-userid:
66104         type: string
66105         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
66106       xauth-user-password:
66107         type: string
66108         description: Encrypted using the Juniper $9$ algorithm
66109       dpd-interval:
66110         type: string
66111         description: The time between DPD probe
66112       dpd-frequency:
66113         type: string
66114         description: Maximum number of DPD before claiming the tunnel is down
66115       resource-version:
66116         type: string
66117         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66118       relationship-list:
66119         type: array
66120         items:
66121           $ref: "#/getDefinitions/relationship"
66122       vig-servers:
66123         type: array
66124         items:
66125           $ref: "#/getDefinitions/vig-server"
66126   ipsec-configurations:
66127     properties:
66128       ipsec-configuration:
66129         type: array
66130         items:
66131           $ref: "#/getDefinitions/ipsec-configuration"
66132   key-data:
66133     properties:
66134       key-name:
66135         type: string
66136       key-value:
66137         type: string
66138   l-interface:
66139     description: |
66140       Logical interfaces, e.g., a vnic.
66141       ###### Related Nodes
66142       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66143       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
66144       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66145       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66146       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
66147       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
66148       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
66149       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
66150       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
66151       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66152       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66153       - FROM logical-link( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
66154       - FROM logical-link( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
66155       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
66156       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
66157       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo l-interface, ONE2MANY)
66158       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
66159       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66160       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,LOGICAL-LINK,SRIOV-VF,VLAN
66161       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
66162     required:
66163     - interface-name
66164     - is-port-mirrored
66165     - in-maint
66166     - is-ip-unnumbered
66167     properties:
66168       interface-name:
66169         type: string
66170         description: Name given to the interface
66171       interface-role:
66172         type: string
66173         description: E.g., CUSTOMER, UPLINK, etc.
66174       v6-wan-link-ip:
66175         type: string
66176         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
66177       selflink:
66178         type: string
66179         description: URL to endpoint where AAI can get more details
66180       interface-id:
66181         type: string
66182         description: ID of interface
66183       macaddr:
66184         type: string
66185         description: MAC address for the interface
66186       network-name:
66187         type: string
66188         description: Name of the network
66189       management-option:
66190         type: string
66191         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
66192       interface-description:
66193         type: string
66194         description: Human friendly text regarding this interface.
66195       is-port-mirrored:
66196         type: boolean
66197       resource-version:
66198         type: string
66199         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66200       in-maint:
66201         type: boolean
66202       prov-status:
66203         type: string
66204         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
66205       is-ip-unnumbered:
66206         type: boolean
66207       allowed-address-pairs:
66208         type: string
66209         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
66210       vlans:
66211         type: array
66212         items:
66213           $ref: "#/getDefinitions/vlan"
66214       sriov-vfs:
66215         type: array
66216         items:
66217           $ref: "#/getDefinitions/sriov-vf"
66218       l-interfaces:
66219         type: array
66220         items:
66221           $ref: "#/getDefinitions/l-interface"
66222       relationship-list:
66223         type: array
66224         items:
66225           $ref: "#/getDefinitions/relationship"
66226       l3-interface-ipv4-address-list:
66227         type: array
66228         items:
66229           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
66230       l3-interface-ipv6-address-list:
66231         type: array
66232         items:
66233           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
66234   l-interfaces:
66235     description: |
66236       Collection of logical interfaces.
66237     properties:
66238       l-interface:
66239         type: array
66240         items:
66241           $ref: "#/getDefinitions/l-interface"
66242   l3-interface-ipv4-address-list:
66243     description: |
66244       IPv4 Address Range
66245       ###### Related Nodes
66246       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
66247       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66248       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66249       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66250       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
66251       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
66252     required:
66253     - l3-interface-ipv4-address
66254     properties:
66255       l3-interface-ipv4-address:
66256         type: string
66257         description: IP address
66258       l3-interface-ipv4-prefix-length:
66259         type: integer
66260         format: int64
66261         description: Prefix length, 32 for single address
66262       vlan-id-inner:
66263         type: integer
66264         format: int64
66265         description: Inner VLAN tag
66266       vlan-id-outer:
66267         type: integer
66268         format: int64
66269         description: Outer VLAN tag
66270       is-floating:
66271         type: boolean
66272         description: Indicator of fixed or floating address
66273       resource-version:
66274         type: string
66275         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66276       neutron-network-id:
66277         type: string
66278         description: Neutron network id of the interface that address belongs to
66279       neutron-subnet-id:
66280         type: string
66281         description: Neutron id of subnet that address belongs to
66282       relationship-list:
66283         type: array
66284         items:
66285           $ref: "#/getDefinitions/relationship"
66286   l3-interface-ipv6-address-list:
66287     description: |
66288       IPv6 Address Range
66289       ###### Related Nodes
66290       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
66291       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66292       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66293       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
66294       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
66295       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
66296     required:
66297     - l3-interface-ipv6-address
66298     properties:
66299       l3-interface-ipv6-address:
66300         type: string
66301         description: IP address
66302       l3-interface-ipv6-prefix-length:
66303         type: integer
66304         format: int64
66305         description: Prefix length, 128 for single address
66306       vlan-id-inner:
66307         type: integer
66308         format: int64
66309         description: Inner VLAN tag
66310       vlan-id-outer:
66311         type: integer
66312         format: int64
66313         description: Outer VLAN tag
66314       is-floating:
66315         type: boolean
66316         description: Indicator of fixed or floating address
66317       resource-version:
66318         type: string
66319         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66320       neutron-network-id:
66321         type: string
66322         description: Neutron network id of the interface that address belongs to
66323       neutron-subnet-id:
66324         type: string
66325         description: Neutron id of subnet that address belongs to
66326       relationship-list:
66327         type: array
66328         items:
66329           $ref: "#/getDefinitions/relationship"
66330   l3-network:
66331     description: |
66332       Generic network definition
66333       ###### Related Nodes
66334       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66335       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
66336       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
66337       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
66338       - TO model-ver( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
66339       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
66340       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66341       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66342       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66343       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66344       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
66345       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66346       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66347       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
66348       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66349       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66350       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
66351       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
66352     required:
66353     - network-id
66354     - network-name
66355     - is-bound-to-vpn
66356     - is-provider-network
66357     - is-shared-network
66358     - is-external-network
66359     properties:
66360       network-id:
66361         type: string
66362         description: Network ID, should be uuid. Unique across A&AI.
66363       network-name:
66364         type: string
66365         description: Name of the network, governed by some naming convention..
66366       network-type:
66367         type: string
66368         description: Type of the network - who defines these values?
66369       network-role:
66370         type: string
66371         description: Role the network plans - who defines these values?
66372       network-technology:
66373         type: string
66374         description: Network technology - who defines these values?
66375       neutron-network-id:
66376         type: string
66377         description: Neutron network id of this Interface
66378       is-bound-to-vpn:
66379         type: boolean
66380       service-id:
66381         type: string
66382         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
66383       network-role-instance:
66384         type: integer
66385         format: int64
66386         description: network role instance
66387       resource-version:
66388         type: string
66389         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66390       orchestration-status:
66391         type: string
66392         description: Orchestration status of this VNF, mastered by MSO
66393       heat-stack-id:
66394         type: string
66395         description: Heat stack id corresponding to this instance, managed by MSO
66396       mso-catalog-key:
66397         type: string
66398         description: Corresponds to the SDN-C catalog id used to configure this VCE
66399       contrail-network-fqdn:
66400         type: string
66401         description: Contrail FQDN for the network
66402       model-invariant-id:
66403         type: string
66404         description: the ASDC model id for this resource or service model.
66405       model-version-id:
66406         type: string
66407         description: the ASDC model version for this resource or service model.
66408       persona-model-version:
66409         type: string
66410         description: the ASDC model version for this resource or service model.
66411       model-customization-id:
66412         type: string
66413         description: captures the id of all the configuration used to customize the resource for the service.
66414       widget-model-id:
66415         type: string
66416         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
66417       widget-model-version:
66418         type: string
66419         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
66420       physical-network-name:
66421         type: string
66422         description: Name associated with the physical network.
66423       is-provider-network:
66424         type: boolean
66425       is-shared-network:
66426         type: boolean
66427       is-external-network:
66428         type: boolean
66429       selflink:
66430         type: string
66431         description: Path to the controller object.
66432       operational-status:
66433         type: string
66434         description: Indicator for whether the resource is considered operational.
66435       subnets:
66436         type: array
66437         items:
66438           $ref: "#/getDefinitions/subnet"
66439       ctag-assignments:
66440         type: array
66441         items:
66442           $ref: "#/getDefinitions/ctag-assignment"
66443       segmentation-assignments:
66444         type: array
66445         items:
66446           $ref: "#/getDefinitions/segmentation-assignment"
66447       relationship-list:
66448         type: array
66449         items:
66450           $ref: "#/getDefinitions/relationship"
66451         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
66452   l3-networks:
66453     properties:
66454       l3-network:
66455         type: array
66456         items:
66457           $ref: "#/getDefinitions/l3-network"
66458   lag-interface:
66459     description: |
66460       Link aggregate interface
66461       ###### Related Nodes
66462       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66463       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
66464       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66465       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
66466       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
66467       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
66468       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
66469       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
66470       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
66471       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
66472       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
66473     required:
66474     - interface-name
66475     - in-maint
66476     properties:
66477       interface-name:
66478         type: string
66479         description: Name that identifies the link aggregate interface
66480       interface-description:
66481         type: string
66482         description: Human friendly text regarding this interface.
66483       resource-version:
66484         type: string
66485         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66486       speed-value:
66487         type: string
66488         description: Captures the numeric part of the speed
66489       speed-units:
66490         type: string
66491         description: Captures the units corresponding to the speed
66492       interface-id:
66493         type: string
66494         description: ID of interface
66495       interface-role:
66496         type: string
66497         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
66498       prov-status:
66499         type: string
66500         description: Trigger for operational monitoring of this resource by Service Assurance systems.
66501       in-maint:
66502         type: boolean
66503       relationship-list:
66504         type: array
66505         items:
66506           $ref: "#/getDefinitions/relationship"
66507       l-interfaces:
66508         type: array
66509         items:
66510           $ref: "#/getDefinitions/l-interface"
66511   lag-interfaces:
66512     description: |
66513       Collection of link aggregate interfaces.
66514     properties:
66515       lag-interface:
66516         type: array
66517         items:
66518           $ref: "#/getDefinitions/lag-interface"
66519   lag-link:
66520     description: |
66521       LAG links can connect lag-interfaces
66522       ###### Related Nodes
66523       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
66524       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
66525     required:
66526     - link-name
66527     properties:
66528       link-name:
66529         type: string
66530         description: Alphabetical concatenation of lag-interface names
66531       resource-version:
66532         type: string
66533         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66534       relationship-list:
66535         type: array
66536         items:
66537           $ref: "#/getDefinitions/relationship"
66538   lag-links:
66539     description: |
66540       Collection of link aggregation connections
66541     properties:
66542       lag-link:
66543         type: array
66544         items:
66545           $ref: "#/getDefinitions/lag-link"
66546   license:
66547     description: |
66548       Metadata for license group.
66549       ###### Related Nodes
66550       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66551       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66552     required:
66553     - group-uuid
66554     - resource-uuid
66555     properties:
66556       group-uuid:
66557         type: string
66558         description: Unique ID for the license group the resource belongs to, should be uuid.
66559       resource-uuid:
66560         type: string
66561         description: Unique ID of a license resource.
66562       resource-version:
66563         type: string
66564         description: Concurrency value
66565       relationship-list:
66566         type: array
66567         items:
66568           $ref: "#/getDefinitions/relationship"
66569   licenses:
66570     description: |
66571       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
66572     properties:
66573       license:
66574         type: array
66575         items:
66576           $ref: "#/getDefinitions/license"
66577   line-of-business:
66578     description: |
66579       describes a line-of-business
66580       ###### Related Nodes
66581       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
66582     required:
66583     - line-of-business-name
66584     properties:
66585       line-of-business-name:
66586         type: string
66587         description: Name of the line-of-business (product)
66588       resource-version:
66589         type: string
66590         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66591       relationship-list:
66592         type: array
66593         items:
66594           $ref: "#/getDefinitions/relationship"
66595   lines-of-business:
66596     description: |
66597       Collection of lines-of-business
66598     properties:
66599       line-of-business:
66600         type: array
66601         items:
66602           $ref: "#/getDefinitions/line-of-business"
66603   logical-link:
66604     description: |
66605       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
66606       ###### Related Nodes
66607       - TO l-interface( logical-link org.onap.relationships.inventory.Source l-interface, ONE2MANY)
66608       - TO l-interface( logical-link org.onap.relationships.inventory.Destination l-interface, ONE2MANY)
66609       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
66610       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
66611       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
66612       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66613       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
66614       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
66615       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
66616       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
66617       - TO model-ver( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
66618       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
66619       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66620       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
66621       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
66622       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
66623       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66624       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
66625     required:
66626     - link-name
66627     - in-maint
66628     - link-type
66629     properties:
66630       link-name:
66631         type: string
66632         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
66633       in-maint:
66634         type: boolean
66635       link-type:
66636         type: string
66637         description: Type of logical link, e.g., evc
66638       speed-value:
66639         type: string
66640         description: Captures the numeric part of the speed
66641       speed-units:
66642         type: string
66643         description: Captures the units corresponding to the speed
66644       ip-version:
66645         type: string
66646         description: v4, v6, or ds for dual stack
66647       routing-protocol:
66648         type: string
66649         description: For example, static or BGP
66650       resource-version:
66651         type: string
66652         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66653       model-invariant-id:
66654         type: string
66655         description: the ASDC model id for this resource or service model.
66656       model-version-id:
66657         type: string
66658         description: the ASDC model version for this resource or service model.
66659       persona-model-version:
66660         type: string
66661         description: the ASDC model version for this resource or service model.
66662       widget-model-id:
66663         type: string
66664         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
66665       widget-model-version:
66666         type: string
66667         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
66668       operational-status:
66669         type: string
66670         description: Indication of operational status of the logical link.
66671       prov-status:
66672         type: string
66673         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
66674       link-role:
66675         type: string
66676         description: Indication of the network use of the logical link.
66677       link-name2:
66678         type: string
66679         description: Alias or alternate name (CLCI or D1 name).
66680       link-id:
66681         type: string
66682         description: UUID of the logical-link, SDNC generates this.
66683       circuit-id:
66684         type: string
66685         description: Circuit id
66686       purpose:
66687         type: string
66688         description: Reason for this entity, role it is playing
66689       relationship-list:
66690         type: array
66691         items:
66692           $ref: "#/getDefinitions/relationship"
66693   logical-links:
66694     description: |
66695       Collection of logical connections
66696     properties:
66697       logical-link:
66698         type: array
66699         items:
66700           $ref: "#/getDefinitions/logical-link"
66701   metadata:
66702     description: |
66703       Collection of metadatum (key/value pairs)
66704     properties:
66705       metadatum:
66706         type: array
66707         items:
66708           $ref: "#/getDefinitions/metadatum"
66709   metadatum:
66710     description: |
66711       Key/value pairs
66712       ###### Related Nodes
66713       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
66714       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
66715       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
66716       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
66717       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
66718     required:
66719     - metaname
66720     - metaval
66721     properties:
66722       metaname:
66723         type: string
66724       metaval:
66725         type: string
66726       resource-version:
66727         type: string
66728         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66729   model:
66730     description: |
66731       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
66732       ###### Related Nodes
66733       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
66734       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
66735       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
66736       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
66737       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
66738       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
66739       - MODEL is DELETED when these are DELETED MODEL-VER
66740     required:
66741     - model-invariant-id
66742     - model-type
66743     properties:
66744       model-invariant-id:
66745         type: string
66746         description: Unique identifier corresponding to the main definition of a model in ASDC
66747       model-type:
66748         type: string
66749         description: Type of the model, e.g., service, resource, widget, etc.
66750       resource-version:
66751         type: string
66752         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66753       model-vers:
66754         type: array
66755         items:
66756           $ref: "#/getDefinitions/model-ver"
66757       relationship-list:
66758         type: array
66759         items:
66760           $ref: "#/getDefinitions/relationship"
66761   model-and-named-query-search:
66762     description: |
66763       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
66764     properties:
66765       query-parameters:
66766         type: object
66767         $ref: "#/getDefinitions/query-parameters"
66768       instance-filters:
66769         type: object
66770         $ref: "#/getDefinitions/instance-filters"
66771       secondary-filts:
66772         type: object
66773         $ref: "#/getDefinitions/secondary-filts"
66774       top-node-type:
66775         type: string
66776       secondary-filter-cut-point:
66777         type: string
66778   model-constraint:
66779     description: |
66780       This is how we would capture constraints defining allowed sets of elements.
66781       ###### Related Nodes
66782       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
66783       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
66784       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
66785     required:
66786     - model-constraint-uuid
66787     - constrained-element-set-uuid-to-replace
66788     properties:
66789       model-constraint-uuid:
66790         type: string
66791       constrained-element-set-uuid-to-replace:
66792         type: string
66793       constrained-element-sets:
66794         type: array
66795         items:
66796           $ref: "#/getDefinitions/constrained-element-set"
66797       resource-version:
66798         type: string
66799         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66800   model-constraints:
66801     properties:
66802       model-constraint:
66803         type: array
66804         items:
66805           $ref: "#/getDefinitions/model-constraint"
66806   model-element:
66807     description: |
66808       Defines how other models combine to make up a higher-level model.
66809       ###### Related Nodes
66810       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
66811       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
66812       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
66813       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
66814       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
66815       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
66816       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
66817       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
66818     required:
66819     - model-element-uuid
66820     - new-data-del-flag
66821     - cardinality
66822     properties:
66823       model-element-uuid:
66824         type: string
66825       new-data-del-flag:
66826         type: string
66827         description: Indicates whether this element was created as part of instantiation from this model
66828       cardinality:
66829         type: string
66830         description: How many of this type of element are required/allowed
66831       linkage-points:
66832         type: string
66833       resource-version:
66834         type: string
66835         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66836       model-elements:
66837         type: array
66838         items:
66839           $ref: "#/getDefinitions/model-element"
66840         description: Defines how other models combine to make up a higher-level model
66841       model-constraints:
66842         type: array
66843         items:
66844           $ref: "#/getDefinitions/model-constraint"
66845         description: Describes new constraints on this model element that are not part of that model's definition
66846       relationship-list:
66847         type: array
66848         items:
66849           $ref: "#/getDefinitions/relationship"
66850   model-elements:
66851     properties:
66852       model-element:
66853         type: array
66854         items:
66855           $ref: "#/getDefinitions/model-element"
66856   model-ver:
66857     description: |
66858       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
66859       ###### Related Nodes
66860       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
66861       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
66862       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
66863       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
66864       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.IsA model-ver, Many2One)
66865       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.IsA model-ver, Many2One)
66866       - FROM l3-network( l3-network org.onap.relationships.inventory.IsA model-ver, Many2One)
66867       - FROM logical-link( logical-link org.onap.relationships.inventory.IsA model-ver, Many2One)
66868       - FROM service-instance( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
66869       - FROM vf-module( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
66870       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
66871       - MODEL-VER is DELETED when these are DELETED METADATUM,MODEL-ELEMENT
66872     required:
66873     - model-version-id
66874     - model-name
66875     - model-version
66876     properties:
66877       model-version-id:
66878         type: string
66879         description: Unique identifier corresponding to one version of a model in ASDC
66880       model-name:
66881         type: string
66882         description: Name of the model, which can change from version to version.
66883       model-version:
66884         type: string
66885         description: Version
66886       distribution-status:
66887         type: string
66888         description: Distribution Status
66889       model-description:
66890         type: string
66891         description: Description
66892       resource-version:
66893         type: string
66894         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66895       model-elements:
66896         type: array
66897         items:
66898           $ref: "#/getDefinitions/model-element"
66899       metadata:
66900         type: array
66901         items:
66902           $ref: "#/getDefinitions/metadatum"
66903       relationship-list:
66904         type: array
66905         items:
66906           $ref: "#/getDefinitions/relationship"
66907   model-vers:
66908     properties:
66909       model-ver:
66910         type: array
66911         items:
66912           $ref: "#/getDefinitions/model-ver"
66913   models:
66914     description: |
66915       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
66916     properties:
66917       model:
66918         type: array
66919         items:
66920           $ref: "#/getDefinitions/model"
66921   multicast-configuration:
66922     description: |
66923       ###### Related Nodes
66924       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
66925     required:
66926     - multicast-configuration-id
66927     - multicast-protocol
66928     - rp-type
66929     properties:
66930       multicast-configuration-id:
66931         type: string
66932         description: Unique id of multicast configuration.
66933       multicast-protocol:
66934         type: string
66935         description: protocol of multicast configuration
66936       rp-type:
66937         type: string
66938         description: rp type of multicast configuration
66939       resource-version:
66940         type: string
66941         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66942       relationship-list:
66943         type: array
66944         items:
66945           $ref: "#/getDefinitions/relationship"
66946   multicast-configurations:
66947     description: |
66948       multicast configuration of generic-vnf ip-address
66949     properties:
66950       multicast-configuration:
66951         type: array
66952         items:
66953           $ref: "#/getDefinitions/multicast-configuration"
66954   named-queries:
66955     properties:
66956       named-query:
66957         type: array
66958         items:
66959           $ref: "#/getDefinitions/named-query"
66960   named-query:
66961     description: |
66962       TBD
66963       ###### Related Nodes
66964       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
66965       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
66966       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
66967       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
66968     required:
66969     - named-query-uuid
66970     - named-query-name
66971     - named-query-version
66972     properties:
66973       named-query-uuid:
66974         type: string
66975       named-query-name:
66976         type: string
66977       named-query-version:
66978         type: string
66979       required-input-param:
66980         type: string
66981       description:
66982         type: string
66983       resource-version:
66984         type: string
66985       named-query-elements:
66986         type: array
66987         items:
66988           $ref: "#/getDefinitions/named-query-element"
66989       relationship-list:
66990         type: array
66991         items:
66992           $ref: "#/getDefinitions/relationship"
66993   named-query-element:
66994     description: |
66995       TBD
66996       ###### Related Nodes
66997       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
66998       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
66999       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67000       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67001       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67002       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67003       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
67004     required:
67005     - named-query-element-uuid
67006     properties:
67007       named-query-element-uuid:
67008         type: string
67009       property-collect-list:
67010         type: string
67011       resource-version:
67012         type: string
67013       property-limit-desc:
67014         type: string
67015       do-not-output:
67016         type: string
67017       named-query-elements:
67018         type: array
67019         items:
67020           $ref: "#/getDefinitions/named-query-element"
67021       related-lookups:
67022         type: array
67023         items:
67024           $ref: "#/getDefinitions/related-lookup"
67025       property-constraints:
67026         type: array
67027         items:
67028           $ref: "#/getDefinitions/property-constraint"
67029       relationship-list:
67030         type: array
67031         items:
67032           $ref: "#/getDefinitions/relationship"
67033   named-query-elements:
67034     properties:
67035       named-query-element:
67036         type: array
67037         items:
67038           $ref: "#/getDefinitions/named-query-element"
67039   network:
67040     description: |
67041       Namespace for network inventory resources.
67042     properties:
67043       logical-links:
67044         type: array
67045         items:
67046           $ref: "#/getDefinitions/logical-link"
67047       site-pair-sets:
67048         type: array
67049         items:
67050           $ref: "#/getDefinitions/site-pair-set"
67051       vpn-bindings:
67052         type: array
67053         items:
67054           $ref: "#/getDefinitions/vpn-binding"
67055       vpls-pes:
67056         type: array
67057         items:
67058           $ref: "#/getDefinitions/vpls-pe"
67059       multicast-configurations:
67060         type: array
67061         items:
67062           $ref: "#/getDefinitions/multicast-configuration"
67063       vces:
67064         type: array
67065         items:
67066           $ref: "#/getDefinitions/vce"
67067       vnfcs:
67068         type: array
67069         items:
67070           $ref: "#/getDefinitions/vnfc"
67071       l3-networks:
67072         type: array
67073         items:
67074           $ref: "#/getDefinitions/l3-network"
67075       network-policies:
67076         type: array
67077         items:
67078           $ref: "#/getDefinitions/network-policy"
67079       generic-vnfs:
67080         type: array
67081         items:
67082           $ref: "#/getDefinitions/generic-vnf"
67083       lag-links:
67084         type: array
67085         items:
67086           $ref: "#/getDefinitions/lag-link"
67087       newvces:
67088         type: array
67089         items:
67090           $ref: "#/getDefinitions/newvce"
67091       pnfs:
67092         type: array
67093         items:
67094           $ref: "#/getDefinitions/pnf"
67095       physical-links:
67096         type: array
67097         items:
67098           $ref: "#/getDefinitions/physical-link"
67099       ipsec-configurations:
67100         type: array
67101         items:
67102           $ref: "#/getDefinitions/ipsec-configuration"
67103       route-table-references:
67104         type: array
67105         items:
67106           $ref: "#/getDefinitions/route-table-reference"
67107       instance-groups:
67108         type: array
67109         items:
67110           $ref: "#/getDefinitions/instance-group"
67111       zones:
67112         type: array
67113         items:
67114           $ref: "#/getDefinitions/zone"
67115       configurations:
67116         type: array
67117         items:
67118           $ref: "#/getDefinitions/configuration"
67119       forwarding-paths:
67120         type: array
67121         items:
67122           $ref: "#/getDefinitions/forwarding-path"
67123   network-policies:
67124     properties:
67125       network-policy:
67126         type: array
67127         items:
67128           $ref: "#/getDefinitions/network-policy"
67129   network-policy:
67130     description: |
67131       ###### Related Nodes
67132       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
67133       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
67134     required:
67135     - network-policy-id
67136     properties:
67137       network-policy-id:
67138         type: string
67139         description: UUID representing unique key to this instance
67140       network-policy-fqdn:
67141         type: string
67142         description: Contrail FQDN for the policy
67143       heat-stack-id:
67144         type: string
67145         description: ID for the openStack Heat instance
67146       resource-version:
67147         type: string
67148         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67149       relationship-list:
67150         type: array
67151         items:
67152           $ref: "#/getDefinitions/relationship"
67153   network-profile:
67154     description: |
67155       Network profile populated by SDN-GP for SNMP
67156       ###### Related Nodes
67157       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
67158     required:
67159     - nm-profile-name
67160     properties:
67161       nm-profile-name:
67162         type: string
67163         description: Unique name of network profile.
67164       community-string:
67165         type: string
67166         description: Encrypted SNMP community string
67167       resource-version:
67168         type: string
67169         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67170       relationship-list:
67171         type: array
67172         items:
67173           $ref: "#/getDefinitions/relationship"
67174   network-profiles:
67175     description: |
67176       Collection of network profiles
67177     properties:
67178       network-profile:
67179         type: array
67180         items:
67181           $ref: "#/getDefinitions/network-profile"
67182   newvce:
67183     description: |
67184       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
67185       ###### Related Nodes
67186       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
67187       - NEWVCE is DELETED when these are DELETED L-INTERFACE
67188     required:
67189     - vnf-id2
67190     - vnf-name
67191     - vnf-type
67192     properties:
67193       vnf-id2:
67194         type: string
67195         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
67196       vnf-name:
67197         type: string
67198         description: Name of VNF.
67199       vnf-name2:
67200         type: string
67201         description: Alternate name of VNF.
67202       vnf-type:
67203         type: string
67204         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.
67205       prov-status:
67206         type: string
67207         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
67208       operational-status:
67209         type: string
67210         description: Indicator for whether the resource is considered operational
67211       license-key:
67212         type: string
67213         description: OBSOLETE -  do not use
67214       ipv4-oam-address:
67215         type: string
67216         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).
67217       equipment-role:
67218         type: string
67219         description: Client should send valid enumerated value.
67220       resource-version:
67221         type: string
67222         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67223       ipv4-loopback0-address:
67224         type: string
67225         description: v4 Loopback0 address
67226       orchestration-status:
67227         type: string
67228         description: Orchestration status of this VNF, mastered by MSO.
67229       heat-stack-id:
67230         type: string
67231         description: Heat stack id corresponding to this instance, managed by MSO
67232       mso-catalog-key:
67233         type: string
67234         description: Corresponds to the SDN-C catalog id used to configure this VCE
67235       relationship-list:
67236         type: array
67237         items:
67238           $ref: "#/getDefinitions/relationship"
67239       l-interfaces:
67240         type: array
67241         items:
67242           $ref: "#/getDefinitions/l-interface"
67243   newvces:
67244     description: |
67245       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
67246     properties:
67247       newvce:
67248         type: array
67249         items:
67250           $ref: "#/getDefinitions/newvce"
67251   notification-event:
67252     properties:
67253       cambria.partition:
67254         type: string
67255       notification-event-header:
67256         type: object
67257         $ref: "#/getDefinitions/notification-event-header"
67258   notification-event-header:
67259     properties:
67260       id:
67261         type: string
67262       timestamp:
67263         type: string
67264       source-name:
67265         type: string
67266       domain:
67267         type: string
67268       sequence-number:
67269         type: string
67270       severity:
67271         type: string
67272       event-type:
67273         type: string
67274       version:
67275         type: string
67276       action:
67277         type: string
67278       entity-type:
67279         type: string
67280       top-entity-type:
67281         type: string
67282       entity-link:
67283         type: string
67284       status:
67285         type: string
67286   notify:
67287     required:
67288     - event-id
67289     properties:
67290       event-id:
67291         type: string
67292       node-type:
67293         type: string
67294       event-trigger:
67295         type: string
67296       key-data:
67297         type: array
67298         items:
67299           $ref: "#/getDefinitions/key-data"
67300       selflink:
67301         type: string
67302   oam-network:
67303     description: |
67304       OAM network, to be deprecated shortly.  Do not use for new purposes.
67305       ###### Related Nodes
67306       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67307       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
67308       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
67309     required:
67310     - network-uuid
67311     - network-name
67312     - cvlan-tag
67313     properties:
67314       network-uuid:
67315         type: string
67316         description: UUID of the network. Unique across a cloud-region
67317       network-name:
67318         type: string
67319         description: Name of the network.
67320       cvlan-tag:
67321         type: integer
67322         format: int64
67323         description: cvlan-id
67324       ipv4-oam-gateway-address:
67325         type: string
67326         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
67327       ipv4-oam-gateway-address-prefix-length:
67328         type: integer
67329         format: int32
67330         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
67331       resource-version:
67332         type: string
67333         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67334       relationship-list:
67335         type: array
67336         items:
67337           $ref: "#/getDefinitions/relationship"
67338   oam-networks:
67339     description: |
67340       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
67341     properties:
67342       oam-network:
67343         type: array
67344         items:
67345           $ref: "#/getDefinitions/oam-network"
67346   operational-environment:
67347     description: |
67348       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
67349       ###### Related Nodes
67350       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
67351       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
67352     required:
67353     - operational-environment-id
67354     - operational-environment-name
67355     - operational-environment-type
67356     - operational-environment-status
67357     - tenant-context
67358     - workload-context
67359     properties:
67360       operational-environment-id:
67361         type: string
67362         description: UUID of an operational environment
67363       operational-environment-name:
67364         type: string
67365         description: Operational Environment name
67366       operational-environment-type:
67367         type: string
67368         description: Operational Environment Type.
67369       operational-environment-status:
67370         type: string
67371         description: Status
67372       tenant-context:
67373         type: string
67374         description: Tenant Context.
67375       workload-context:
67376         type: string
67377         description: Workload Context.
67378       resource-version:
67379         type: string
67380         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67381       relationship-list:
67382         type: array
67383         items:
67384           $ref: "#/getDefinitions/relationship"
67385   operational-environments:
67386     description: |
67387       a logical partition of the cloud which allows to have multiple environments in the production AIC.
67388     properties:
67389       operational-environment:
67390         type: array
67391         items:
67392           $ref: "#/getDefinitions/operational-environment"
67393   overloaded-model:
67394     description: |
67395       Allows for legacy POST of old-style and new-style models
67396     required:
67397     - model-invariant-id
67398     - model-name-version-id
67399     - model-type
67400     - model-name
67401     - model-id
67402     - model-version
67403     properties:
67404       model-invariant-id:
67405         type: string
67406         description: Unique identifier corresponding to the main definition of a model in ASDC
67407       model-name-version-id:
67408         type: string
67409         description: Unique identifier corresponding to one version of a model in ASDC
67410       model-type:
67411         type: string
67412         description: Type of the model, e.g., service, resource, widget, etc.
67413       model-name:
67414         type: string
67415         description: Name of the model, which can change from version to version.
67416       model-id:
67417         type: string
67418         description: Invariant unique ID which does not change from version to version
67419       model-version:
67420         type: string
67421         description: Version
67422       model-description:
67423         type: string
67424         description: Description
67425       resource-version:
67426         type: string
67427         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67428       model-vers:
67429         type: object
67430         $ref: "#/getDefinitions/model-vers"
67431       relationship-list:
67432         type: object
67433         $ref: "#/getDefinitions/relationship-list"
67434   owning-entities:
67435     description: |
67436       Collection of owning-entities
67437     properties:
67438       owning-entity:
67439         type: array
67440         items:
67441           $ref: "#/getDefinitions/owning-entity"
67442   owning-entity:
67443     description: |
67444       describes an owning-entity
67445       ###### Related Nodes
67446       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
67447     required:
67448     - owning-entity-id
67449     - owning-entity-name
67450     properties:
67451       owning-entity-id:
67452         type: string
67453         description: UUID of an owning entity
67454       owning-entity-name:
67455         type: string
67456         description: Owning entity name
67457       resource-version:
67458         type: string
67459         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67460       relationship-list:
67461         type: array
67462         items:
67463           $ref: "#/getDefinitions/relationship"
67464   p-interface:
67465     description: |
67466       Physical interface (e.g., nic)
67467       ###### Related Nodes
67468       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
67469       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
67470       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
67471       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
67472       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
67473       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
67474       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
67475       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
67476       - FROM forwarder( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
67477       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
67478       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
67479     required:
67480     - interface-name
67481     - in-maint
67482     properties:
67483       interface-name:
67484         type: string
67485         description: Name that identifies the physical interface
67486       selflink:
67487         type: string
67488         description: URL to endpoint where AAI can get more details.
67489       speed-value:
67490         type: string
67491         description: Captures the numeric part of the speed
67492       speed-units:
67493         type: string
67494         description: Captures the units corresponding to the speed
67495       port-description:
67496         type: string
67497         description: Nature of the services and connectivity on this port.
67498       equipment-identifier:
67499         type: string
67500         description: CLEI or other specification for p-interface hardware.
67501       interface-role:
67502         type: string
67503         description: Role specification for p-interface hardware.
67504       interface-type:
67505         type: string
67506         description: Indicates the physical properties of the interface.
67507       prov-status:
67508         type: string
67509         description: Trigger for operational monitoring of this resource by Service Assurance systems.
67510       mac-addresss:
67511         type: string
67512         description: MAC Address of the p-interface.
67513       resource-version:
67514         type: string
67515         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67516       in-maint:
67517         type: boolean
67518       inv-status:
67519         type: string
67520         description: inventory status
67521       relationship-list:
67522         type: array
67523         items:
67524           $ref: "#/getDefinitions/relationship"
67525       sriov-pfs:
67526         type: array
67527         items:
67528           $ref: "#/getDefinitions/sriov-pf"
67529       l-interfaces:
67530         type: array
67531         items:
67532           $ref: "#/getDefinitions/l-interface"
67533   p-interfaces:
67534     description: |
67535       Collection of physical interfaces.
67536     properties:
67537       p-interface:
67538         type: array
67539         items:
67540           $ref: "#/getDefinitions/p-interface"
67541   physical-link:
67542     description: |
67543       Collection of physical connections, typically between p-interfaces
67544       ###### Related Nodes
67545       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
67546     required:
67547     - link-name
67548     properties:
67549       link-name:
67550         type: string
67551         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
67552       speed-value:
67553         type: string
67554         description: Captures the numeric part of the speed
67555       speed-units:
67556         type: string
67557         description: Captures the units corresponding to the speed
67558       circuit-id:
67559         type: string
67560         description: Circuit it
67561       dual-mode:
67562         type: string
67563         description: Dual access mode (e.g., primary, secondary
67564       management-option:
67565         type: string
67566         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
67567       service-provider-name:
67568         type: string
67569         description: Name of the service Provider on this link.
67570       service-provider-bandwidth-up-value:
67571         type: integer
67572         format: int32
67573         description: Upstream Bandwidth value agreed with the service provider
67574       service-provider-bandwidth-up-units:
67575         type: string
67576         description: Units for the upstream BW value
67577       service-provider-bandwidth-down-value:
67578         type: integer
67579         format: int32
67580         description: Downstream Bandwidth value agreed with the service provider
67581       service-provider-bandwidth-down-units:
67582         type: string
67583         description: Units for downstream BW value
67584       resource-version:
67585         type: string
67586         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67587       relationship-list:
67588         type: array
67589         items:
67590           $ref: "#/getDefinitions/relationship"
67591   physical-links:
67592     description: |
67593       Collection of physical connections, typically between p-interfaces
67594     properties:
67595       physical-link:
67596         type: array
67597         items:
67598           $ref: "#/getDefinitions/physical-link"
67599   platform:
67600     description: |
67601       describes a platform
67602       ###### Related Nodes
67603       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
67604     required:
67605     - platform-name
67606     properties:
67607       platform-name:
67608         type: string
67609         description: Name of the platform
67610       resource-version:
67611         type: string
67612         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67613       relationship-list:
67614         type: array
67615         items:
67616           $ref: "#/getDefinitions/relationship"
67617   platforms:
67618     description: |
67619       Collection of platforms
67620     properties:
67621       platform:
67622         type: array
67623         items:
67624           $ref: "#/getDefinitions/platform"
67625   pnf:
67626     description: |
67627       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.
67628       ###### Related Nodes
67629       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67630       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67631       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67632       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
67633       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
67634       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
67635       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
67636       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
67637       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
67638       - FROM configuration( configuration org.onap.relationships.inventory.AppliesTo pnf, ONE2MANY)
67639       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
67640     required:
67641     - pnf-name
67642     - in-maint
67643     properties:
67644       pnf-name:
67645         type: string
67646         description: unique name of Physical Network Function.
67647       pnf-name2:
67648         type: string
67649         description: name of Physical Network Function.
67650       selflink:
67651         type: string
67652         description: URL to endpoint where AAI can get more details.
67653       pnf-name2-source:
67654         type: string
67655         description: source of name2
67656       pnf-id:
67657         type: string
67658         description: id of pnf
67659       equip-type:
67660         type: string
67661         description: Equipment type.  Source of truth should define valid values.
67662       equip-vendor:
67663         type: string
67664         description: Equipment vendor.  Source of truth should define valid values.
67665       equip-model:
67666         type: string
67667         description: Equipment model.  Source of truth should define valid values.
67668       management-option:
67669         type: string
67670         description: identifier of managed by ATT or customer
67671       ipaddress-v4-oam:
67672         type: string
67673         description: ipv4-oam-address with new naming convention for IP addresses
67674       sw-version:
67675         type: string
67676         description: sw-version is the version of SW for the hosted application on the PNF.
67677       in-maint:
67678         type: boolean
67679       frame-id:
67680         type: string
67681         description: ID of the physical frame (relay rack) where pnf is installed.
67682       serial-number:
67683         type: string
67684         description: Serial number of the device
67685       ipaddress-v4-loopback-0:
67686         type: string
67687         description: IPV4 Loopback 0 address
67688       ipaddress-v6-loopback-0:
67689         type: string
67690         description: IPV6 Loopback 0 address
67691       ipaddress-v4-aim:
67692         type: string
67693         description: IPV4 AIM address
67694       ipaddress-v6-aim:
67695         type: string
67696         description: IPV6 AIM address
67697       ipaddress-v6-oam:
67698         type: string
67699         description: IPV6 OAM address
67700       inv-status:
67701         type: string
67702         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
67703       resource-version:
67704         type: string
67705         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67706       prov-status:
67707         type: string
67708         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
67709       nf-role:
67710         type: string
67711         description: Nf Role is the role performed by this instance in the network.
67712       relationship-list:
67713         type: array
67714         items:
67715           $ref: "#/getDefinitions/relationship"
67716       p-interfaces:
67717         type: array
67718         items:
67719           $ref: "#/getDefinitions/p-interface"
67720       lag-interfaces:
67721         type: array
67722         items:
67723           $ref: "#/getDefinitions/lag-interface"
67724   pnfs:
67725     description: |
67726       Collection of Physical Network Functions.
67727     properties:
67728       pnf:
67729         type: array
67730         items:
67731           $ref: "#/getDefinitions/pnf"
67732   port-group:
67733     description: |
67734       Used to capture the network interfaces of this VCE
67735       ###### Related Nodes
67736       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
67737       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
67738       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
67739     required:
67740     - interface-id
67741     - orchestration-status
67742     properties:
67743       interface-id:
67744         type: string
67745         description: Unique ID of the interface
67746       neutron-network-id:
67747         type: string
67748         description: Neutron network id of this Interface
67749       neutron-network-name:
67750         type: string
67751         description: Neutron network name of this Interface
67752       interface-role:
67753         type: string
67754         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
67755       resource-version:
67756         type: string
67757         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67758       port-group-id:
67759         type: string
67760         description: Unique ID for port group in vmware
67761       port-group-name:
67762         type: string
67763         description: Likely to duplicate value of neutron network name
67764       switch-name:
67765         type: string
67766         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
67767       orchestration-status:
67768         type: string
67769         description: Orchestration status of this VNF, mastered by MSO
67770       heat-stack-id:
67771         type: string
67772         description: Heat stack id corresponding to this instance, managed by MSO
67773       mso-catalog-key:
67774         type: string
67775         description: Corresponds to the SDN-C catalog id used to configure this VCE
67776       cvlan-tags:
67777         type: array
67778         items:
67779           $ref: "#/getDefinitions/cvlan-tag-entry"
67780       relationship-list:
67781         type: array
67782         items:
67783           $ref: "#/getDefinitions/relationship"
67784   port-groups:
67785     properties:
67786       port-group:
67787         type: array
67788         items:
67789           $ref: "#/getDefinitions/port-group"
67790   project:
67791     description: |
67792       describes the project
67793       ###### Related Nodes
67794       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
67795     required:
67796     - project-name
67797     properties:
67798       project-name:
67799         type: string
67800         description: Name of the project deploying a service
67801       resource-version:
67802         type: string
67803         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67804       relationship-list:
67805         type: array
67806         items:
67807           $ref: "#/getDefinitions/relationship"
67808   projects:
67809     description: |
67810       Collection of projects
67811     properties:
67812       project:
67813         type: array
67814         items:
67815           $ref: "#/getDefinitions/project"
67816   properties:
67817     description: |
67818       Property holder for query properties or instance properties
67819     properties:
67820       property-name:
67821         type: string
67822       property-value:
67823         type: string
67824   property-constraint:
67825     description: |
67826       TBD
67827       ###### Related Nodes
67828       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67829     required:
67830     - property-constraint-uuid
67831     - constraint-type
67832     - property-name
67833     - property-value
67834     properties:
67835       property-constraint-uuid:
67836         type: string
67837       constraint-type:
67838         type: string
67839       property-name:
67840         type: string
67841       property-value:
67842         type: string
67843       resource-version:
67844         type: string
67845   property-constraints:
67846     properties:
67847       property-constraint:
67848         type: array
67849         items:
67850           $ref: "#/getDefinitions/property-constraint"
67851   pserver:
67852     description: |
67853       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
67854       ###### Related Nodes
67855       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
67856       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
67857       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
67858       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67859       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67860       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
67861       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
67862       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
67863       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
67864       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
67865       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
67866       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
67867       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
67868     required:
67869     - hostname
67870     - in-maint
67871     properties:
67872       hostname:
67873         type: string
67874         description: Value from executing hostname on the compute node.
67875       ptnii-equip-name:
67876         type: string
67877         description: PTNII name
67878       number-of-cpus:
67879         type: integer
67880         format: int32
67881         description: Number of cpus
67882       disk-in-gigabytes:
67883         type: integer
67884         format: int32
67885         description: Disk size, in GBs
67886       ram-in-megabytes:
67887         type: integer
67888         format: int32
67889         description: RAM size, in MBs
67890       equip-type:
67891         type: string
67892         description: Equipment type.  Source of truth should define valid values.
67893       equip-vendor:
67894         type: string
67895         description: Equipment vendor.  Source of truth should define valid values.
67896       equip-model:
67897         type: string
67898         description: Equipment model.  Source of truth should define valid values.
67899       fqdn:
67900         type: string
67901         description: Fully-qualified domain name
67902       pserver-selflink:
67903         type: string
67904         description: URL to endpoint where AAI can get more details
67905       ipv4-oam-address:
67906         type: string
67907         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
67908       serial-number:
67909         type: string
67910         description: Serial number, may be queried
67911       ipaddress-v4-loopback-0:
67912         type: string
67913         description: IPV4 Loopback 0 address
67914       ipaddress-v6-loopback-0:
67915         type: string
67916         description: IPV6 Loopback 0 address
67917       ipaddress-v4-aim:
67918         type: string
67919         description: IPV4 AIM address
67920       ipaddress-v6-aim:
67921         type: string
67922         description: IPV6 AIM address
67923       ipaddress-v6-oam:
67924         type: string
67925         description: IPV6 OAM address
67926       inv-status:
67927         type: string
67928         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
67929       pserver-id:
67930         type: string
67931         description: ID of Pserver
67932       internet-topology:
67933         type: string
67934         description: internet topology of Pserver
67935       in-maint:
67936         type: boolean
67937       resource-version:
67938         type: string
67939         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67940       pserver-name2:
67941         type: string
67942         description: alternative pserver name
67943       purpose:
67944         type: string
67945         description: purpose of pserver
67946       prov-status:
67947         type: string
67948         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
67949       management-option:
67950         type: string
67951         description: Indicates who owns and or manages the device.
67952       host-profile:
67953         type: string
67954         description: The host profile that defines the configuration of the pserver.
67955       relationship-list:
67956         type: array
67957         items:
67958           $ref: "#/getDefinitions/relationship"
67959       p-interfaces:
67960         type: array
67961         items:
67962           $ref: "#/getDefinitions/p-interface"
67963       lag-interfaces:
67964         type: array
67965         items:
67966           $ref: "#/getDefinitions/lag-interface"
67967   pservers:
67968     description: |
67969       Collection of compute hosts.
67970     properties:
67971       pserver:
67972         type: array
67973         items:
67974           $ref: "#/getDefinitions/pserver"
67975   query-parameters:
67976     description: |
67977       QueryParameters for performing a named-query or model query
67978     properties:
67979       named-query:
67980         type: object
67981         $ref: "#/getDefinitions/named-query"
67982       overloaded-model:
67983         type: object
67984         $ref: "#/getDefinitions/overloaded-model"
67985   related-lookup:
67986     description: |
67987       TBD
67988       ###### Related Nodes
67989       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
67990     required:
67991     - related-lookup-uuid
67992     - source-node-type
67993     - source-node-property
67994     - target-node-type
67995     - target-node-property
67996     properties:
67997       related-lookup-uuid:
67998         type: string
67999       source-node-type:
68000         type: string
68001       source-node-property:
68002         type: string
68003       target-node-type:
68004         type: string
68005       target-node-property:
68006         type: string
68007       property-collect-list:
68008         type: string
68009       resource-version:
68010         type: string
68011       relationship-list:
68012         type: array
68013         items:
68014           $ref: "#/getDefinitions/relationship"
68015   related-lookups:
68016     properties:
68017       related-lookup:
68018         type: array
68019         items:
68020           $ref: "#/getDefinitions/related-lookup"
68021   related-to-property:
68022     properties:
68023       property-key:
68024         type: string
68025         description: Key part of a key/value pair
68026       property-value:
68027         type: string
68028         description: Value part of a key/value pair
68029   relationship:
68030     properties:
68031       related-to:
68032         type: string
68033         description: A keyword provided by A&AI to indicate type of node.
68034       relationship-label:
68035         type: string
68036         description: The edge label for this relationship.
68037       related-link:
68038         type: string
68039         description: URL to the object in A&AI.
68040       relationship-data:
68041         type: array
68042         items:
68043           $ref: "#/getDefinitions/relationship-data"
68044       related-to-property:
68045         type: array
68046         items:
68047           $ref: "#/getDefinitions/related-to-property"
68048   relationship-data:
68049     required:
68050     - relationship-key
68051     - relationship-value
68052     properties:
68053       relationship-key:
68054         type: string
68055         description: A keyword provided by A&AI to indicate an attribute.
68056       relationship-value:
68057         type: string
68058         description: Value of the attribute.
68059   relationship-list:
68060     properties:
68061       relationship:
68062         type: array
68063         items:
68064           $ref: "#/getDefinitions/relationship"
68065   reserved-prop-names:
68066     description: |
68067       Internal map to define some reserved properties of a vertex
68068     properties:
68069       last-mod-source-of-truth:
68070         type: string
68071       aai-node-type:
68072         type: string
68073       aai-created-ts:
68074         type: integer
68075         format: int64
68076       aai-unique-key:
68077         type: string
68078       aai-last-mod-ts:
68079         type: integer
68080         format: int64
68081       source-of-truth:
68082         type: string
68083       aai-uri:
68084         type: string
68085   response-list:
68086     description: |
68087       Response container for the results of a named-query or model query
68088     properties:
68089       inventory-response-items:
68090         type: object
68091         $ref: "#/getDefinitions/inventory-response-items"
68092   result-data:
68093     properties:
68094       resource-type:
68095         type: string
68096         description: The specific type of node in the A&AI graph
68097       resource-link:
68098         type: string
68099         description: The URL to the specific resource
68100   route-table-reference:
68101     description: |
68102       Openstack route table reference.
68103       ###### Related Nodes
68104       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
68105     required:
68106     - route-table-reference-id
68107     - route-table-reference-fqdn
68108     properties:
68109       route-table-reference-id:
68110         type: string
68111         description: Route Table Reference id, UUID assigned to this instance.
68112       route-table-reference-fqdn:
68113         type: string
68114         description: FQDN entry in the route table.
68115       resource-version:
68116         type: string
68117         description: Concurrency value
68118       relationship-list:
68119         type: array
68120         items:
68121           $ref: "#/getDefinitions/relationship"
68122   route-table-references:
68123     description: |
68124       Collection of openstack route table references
68125     properties:
68126       route-table-reference:
68127         type: array
68128         items:
68129           $ref: "#/getDefinitions/route-table-reference"
68130   route-target:
68131     description: |
68132       Route target information
68133       ###### Related Nodes
68134       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
68135     required:
68136     - global-route-target
68137     - route-target-role
68138     properties:
68139       global-route-target:
68140         type: string
68141         description: Number used to identify an RT, globally unique in the network
68142       route-target-role:
68143         type: string
68144         description: Role assigned to this route target
68145       resource-version:
68146         type: string
68147         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68148       relationship-list:
68149         type: array
68150         items:
68151           $ref: "#/getDefinitions/relationship"
68152   route-targets:
68153     description: |
68154       Collection of route target information
68155     properties:
68156       route-target:
68157         type: array
68158         items:
68159           $ref: "#/getDefinitions/route-target"
68160   routing-instance:
68161     description: |
68162       ###### Related Nodes
68163       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
68164       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
68165       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
68166     required:
68167     - routing-instance-id
68168     properties:
68169       routing-instance-id:
68170         type: string
68171         description: Unique id of routing instance
68172       rpm-owner:
68173         type: string
68174         description: rpm owner
68175       resource-version:
68176         type: string
68177         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68178       site-pairs:
68179         type: array
68180         items:
68181           $ref: "#/getDefinitions/site-pair"
68182       relationship-list:
68183         type: array
68184         items:
68185           $ref: "#/getDefinitions/relationship"
68186   routing-instances:
68187     description: |
68188       set of probes related to generic-vnf routing instance
68189     properties:
68190       routing-instance:
68191         type: array
68192         items:
68193           $ref: "#/getDefinitions/routing-instance"
68194   sdn-zone-response:
68195     properties:
68196       oam-networks:
68197         type: object
68198         $ref: "#/getDefinitions/oam-networks"
68199       az-and-dvs-switches:
68200         type: array
68201         items:
68202           $ref: "#/getDefinitions/az-and-dvs-switches"
68203   search:
68204     properties:
68205       edge-tag-query-result:
68206         type: object
68207         $ref: "#/getDefinitions/edge-tag-query-result"
68208       edge-tag-query-request:
68209         type: object
68210         $ref: "#/getDefinitions/edge-tag-query-request"
68211       search-results:
68212         type: object
68213         $ref: "#/getDefinitions/search-results"
68214       sdn-zone-response:
68215         type: object
68216         $ref: "#/getDefinitions/sdn-zone-response"
68217   search-results:
68218     properties:
68219       result-data:
68220         type: array
68221         items:
68222           $ref: "#/getDefinitions/result-data"
68223   secondary-filt:
68224     description: |
68225       SecondaryFilt for performing a named-query or model query
68226   secondary-filter:
68227     properties:
68228       property-name:
68229         type: string
68230       filter-type:
68231         type: string
68232       property-value:
68233         type: string
68234   secondary-filts:
68235     description: |
68236       SecondaryFilts for performing a named-query or model query
68237     properties:
68238       secondary-filt:
68239         type: array
68240         items:
68241           $ref: "#/getDefinitions/secondary-filt"
68242   segmentation-assignment:
68243     description: |
68244       Openstack segmentation assignment.
68245       ###### Related Nodes
68246       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
68247     required:
68248     - segmentation-id
68249     properties:
68250       segmentation-id:
68251         type: string
68252         description: Route Table Reference id, UUID assigned to this instance.
68253       resource-version:
68254         type: string
68255         description: Concurrency value
68256       relationship-list:
68257         type: array
68258         items:
68259           $ref: "#/getDefinitions/relationship"
68260   segmentation-assignments:
68261     description: |
68262       Collection of openstack segmentation assignments
68263     properties:
68264       segmentation-assignment:
68265         type: array
68266         items:
68267           $ref: "#/getDefinitions/segmentation-assignment"
68268   service:
68269     description: |
68270       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
68271     required:
68272     - service-id
68273     - service-description
68274     properties:
68275       service-id:
68276         type: string
68277         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
68278       service-description:
68279         type: string
68280         description: Description of the service
68281       service-selflink:
68282         type: string
68283         description: URL to endpoint where AAI can get more details
68284       resource-version:
68285         type: string
68286         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68287       service-version:
68288         type: string
68289         description: service version
68290       relationship-list:
68291         type: array
68292         items:
68293           $ref: "#/getDefinitions/relationship"
68294   service-capabilities:
68295     description: |
68296       Collection of service capabilities.
68297     properties:
68298       service-capability:
68299         type: array
68300         items:
68301           $ref: "#/getDefinitions/service-capability"
68302   service-capability:
68303     description: |
68304       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
68305       ###### Related Nodes
68306       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
68307       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
68308       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
68309     required:
68310     - service-type
68311     - vnf-type
68312     properties:
68313       service-type:
68314         type: string
68315         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
68316       vnf-type:
68317         type: string
68318         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.
68319       resource-version:
68320         type: string
68321         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68322       relationship-list:
68323         type: array
68324         items:
68325           $ref: "#/getDefinitions/relationship"
68326   service-design-and-creation:
68327     description: |
68328       Namespace for objects managed by ASDC
68329     properties:
68330       vnf-images:
68331         type: array
68332         items:
68333           $ref: "#/getDefinitions/vnf-image"
68334       services:
68335         type: array
68336         items:
68337           $ref: "#/getDefinitions/service"
68338       service-capabilities:
68339         type: array
68340         items:
68341           $ref: "#/getDefinitions/service-capability"
68342       models:
68343         type: array
68344         items:
68345           $ref: "#/getDefinitions/model"
68346       named-queries:
68347         type: array
68348         items:
68349           $ref: "#/getDefinitions/named-query"
68350   service-instance:
68351     description: |
68352       Instance of a service
68353       ###### Related Nodes
68354       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
68355       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
68356       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
68357       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
68358       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
68359       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
68360       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
68361       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
68362       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
68363       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
68364       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
68365       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
68366       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
68367       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
68368       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
68369       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
68370       - TO model-ver( service-instance org.onap.relationships.inventory.IsA model-ver, Many2One)
68371       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
68372       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
68373       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
68374       - FROM forwarding-path( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
68375       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
68376       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM,FORWARDING-PATH
68377       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
68378     required:
68379     - service-instance-id
68380     - service-type
68381     - service-role
68382     - created-at
68383     - updated-at
68384     - description
68385     properties:
68386       service-instance-id:
68387         type: string
68388         description: Uniquely identifies this instance of a service
68389       service-instance-name:
68390         type: string
68391         description: This field will store a name assigned to the service-instance.
68392       service-type:
68393         type: string
68394         description: String capturing type of service.
68395       service-role:
68396         type: string
68397         description: String capturing the service role.
68398       environment-context:
68399         type: string
68400         description: This field will store the environment context assigned to the service-instance.
68401       workload-context:
68402         type: string
68403         description: This field will store the workload context assigned to the service-instance.
68404       created-at:
68405         type: string
68406         description: create time of Network Service.
68407       updated-at:
68408         type: string
68409         description: last update of Network Service.
68410       description:
68411         type: string
68412         description: short description for service-instance.
68413       model-invariant-id:
68414         type: string
68415         description: the ASDC model id for this resource or service model.
68416       model-version-id:
68417         type: string
68418         description: the ASDC model version for this resource or service model.
68419       persona-model-version:
68420         type: string
68421         description: the ASDC model version for this resource or service model.
68422       widget-model-id:
68423         type: string
68424         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
68425       widget-model-version:
68426         type: string
68427         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
68428       bandwidth-total:
68429         type: string
68430         description: Indicates the total bandwidth to be used for this service.
68431       bandwidth-up-wan1:
68432         type: string
68433         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
68434       bandwidth-down-wan1:
68435         type: string
68436         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
68437       bandwidth-up-wan2:
68438         type: string
68439         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
68440       bandwidth-down-wan2:
68441         type: string
68442         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
68443       vhn-portal-url:
68444         type: string
68445         description: URL customers will use to access the vHN Portal.
68446       service-instance-location-id:
68447         type: string
68448         description: An identifier that customers assign to the location where this service is being used.
68449       resource-version:
68450         type: string
68451         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68452       selflink:
68453         type: string
68454         description: Path to the controller object.
68455       orchestration-status:
68456         type: string
68457         description: Orchestration status of this service.
68458       relationship-list:
68459         type: array
68460         items:
68461           $ref: "#/getDefinitions/relationship"
68462       metadata:
68463         type: array
68464         items:
68465           $ref: "#/getDefinitions/metadatum"
68466       allotted-resources:
68467         type: array
68468         items:
68469           $ref: "#/getDefinitions/allotted-resource"
68470   service-instances:
68471     description: |
68472       Collection of service instances
68473     properties:
68474       service-instance:
68475         type: array
68476         items:
68477           $ref: "#/getDefinitions/service-instance"
68478   service-subscription:
68479     description: |
68480       Object that group service instances.
68481       ###### Related Nodes
68482       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
68483       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
68484       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
68485       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
68486     required:
68487     - service-type
68488     properties:
68489       service-type:
68490         type: string
68491         description: Value defined by orchestration to identify this service across ECOMP.
68492       temp-ub-sub-account-id:
68493         type: string
68494         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
68495       resource-version:
68496         type: string
68497         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68498       service-instances:
68499         type: array
68500         items:
68501           $ref: "#/getDefinitions/service-instance"
68502       relationship-list:
68503         type: array
68504         items:
68505           $ref: "#/getDefinitions/relationship"
68506   service-subscriptions:
68507     description: |
68508       Collection of objects that group service instances.
68509     properties:
68510       service-subscription:
68511         type: array
68512         items:
68513           $ref: "#/getDefinitions/service-subscription"
68514   services:
68515     description: |
68516       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
68517     properties:
68518       service:
68519         type: array
68520         items:
68521           $ref: "#/getDefinitions/service"
68522   site-pair:
68523     description: |
68524       ###### Related Nodes
68525       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
68526       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
68527       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
68528     required:
68529     - site-pair-id
68530     properties:
68531       site-pair-id:
68532         type: string
68533         description: unique identifier of probe
68534       source-ip:
68535         type: string
68536         description: Prefix address
68537       destination-ip:
68538         type: string
68539         description: Prefix address
68540       ip-version:
68541         type: string
68542         description: ip version, v4, v6
68543       destination-hostname:
68544         type: string
68545         description: Hostname of the destination equipment to which SLAs are measured against.
68546       destination-equip-type:
68547         type: string
68548         description: The type of destinatination equipment. Could be Router, UCPE, etc.
68549       resource-version:
68550         type: string
68551         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68552       classes-of-service:
68553         type: array
68554         items:
68555           $ref: "#/getDefinitions/class-of-service"
68556       relationship-list:
68557         type: array
68558         items:
68559           $ref: "#/getDefinitions/relationship"
68560   site-pair-set:
68561     description: |
68562       Set of instances for probes used to measure service level agreements
68563       ###### Related Nodes
68564       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
68565       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
68566       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
68567     required:
68568     - site-pair-set-id
68569     properties:
68570       site-pair-set-id:
68571         type: string
68572         description: Unique id of site pair set.
68573       resource-version:
68574         type: string
68575         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68576       routing-instances:
68577         type: array
68578         items:
68579           $ref: "#/getDefinitions/routing-instance"
68580       relationship-list:
68581         type: array
68582         items:
68583           $ref: "#/getDefinitions/relationship"
68584   site-pair-sets:
68585     description: |
68586       Collection of sets of instances for probes related to generic-vnf
68587     properties:
68588       site-pair-set:
68589         type: array
68590         items:
68591           $ref: "#/getDefinitions/site-pair-set"
68592   site-pairs:
68593     description: |
68594       probe within a set
68595     properties:
68596       site-pair:
68597         type: array
68598         items:
68599           $ref: "#/getDefinitions/site-pair"
68600   snapshot:
68601     description: |
68602       Openstack snapshot
68603       ###### Related Nodes
68604       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
68605       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
68606     required:
68607     - snapshot-id
68608     properties:
68609       snapshot-id:
68610         type: string
68611         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
68612       snapshot-name:
68613         type: string
68614         description: Snapshot name
68615       snapshot-architecture:
68616         type: string
68617         description: Operating system architecture
68618       snapshot-os-distro:
68619         type: string
68620         description: The common name of the operating system distribution in lowercase
68621       snapshot-os-version:
68622         type: string
68623         description: The operating system version as specified by the distributor.
68624       application:
68625         type: string
68626         description: The application that the image instantiates.
68627       application-vendor:
68628         type: string
68629         description: The vendor of the application.
68630       application-version:
68631         type: string
68632         description: The version of the application.
68633       snapshot-selflink:
68634         type: string
68635         description: URL to endpoint where AAI can get more details
68636       prev-snapshot-id:
68637         type: string
68638         description: This field contains the UUID of the previous snapshot (if any).
68639       resource-version:
68640         type: string
68641         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68642       relationship-list:
68643         type: array
68644         items:
68645           $ref: "#/getDefinitions/relationship"
68646   snapshots:
68647     description: |
68648       Collection of openstack snapshots
68649     properties:
68650       snapshot:
68651         type: array
68652         items:
68653           $ref: "#/getDefinitions/snapshot"
68654   sriov-pf:
68655     description: |
68656       SR-IOV Physical Function
68657       ###### Related Nodes
68658       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
68659       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
68660     required:
68661     - pf-pci-id
68662     properties:
68663       pf-pci-id:
68664         type: string
68665         description: Identifier for the sriov-pf
68666       resource-version:
68667         type: string
68668         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68669       relationship-list:
68670         type: array
68671         items:
68672           $ref: "#/getDefinitions/relationship"
68673   sriov-pfs:
68674     description: |
68675       Collection of SR-IOV Physical Functions.
68676     properties:
68677       sriov-pf:
68678         type: array
68679         items:
68680           $ref: "#/getDefinitions/sriov-pf"
68681   sriov-vf:
68682     description: |
68683       SR-IOV Virtual Function (not to be confused with virtual network function)
68684       ###### Related Nodes
68685       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
68686       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
68687     required:
68688     - pci-id
68689     properties:
68690       pci-id:
68691         type: string
68692         description: PCI ID used to identify the sriov-vf
68693       vf-vlan-filter:
68694         type: string
68695         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
68696       vf-mac-filter:
68697         type: string
68698         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
68699       vf-vlan-strip:
68700         type: boolean
68701         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
68702       vf-vlan-anti-spoof-check:
68703         type: boolean
68704         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.
68705       vf-mac-anti-spoof-check:
68706         type: boolean
68707         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.
68708       vf-mirrors:
68709         type: string
68710         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
68711       vf-broadcast-allow:
68712         type: boolean
68713         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
68714       vf-unknown-multicast-allow:
68715         type: boolean
68716         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
68717       vf-unknown-unicast-allow:
68718         type: boolean
68719         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
68720       vf-insert-stag:
68721         type: boolean
68722         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
68723       vf-link-status:
68724         type: string
68725         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
68726       resource-version:
68727         type: string
68728         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68729       neutron-network-id:
68730         type: string
68731         description: Neutron network id of the interface
68732       relationship-list:
68733         type: array
68734         items:
68735           $ref: "#/getDefinitions/relationship"
68736   sriov-vfs:
68737     description: |
68738       Collection of SR-IOV Virtual Functions.
68739     properties:
68740       sriov-vf:
68741         type: array
68742         items:
68743           $ref: "#/getDefinitions/sriov-vf"
68744   start-node-filter:
68745     properties:
68746       property-name:
68747         type: string
68748       property-value:
68749         type: string
68750   subnet:
68751     description: |
68752       ###### Related Nodes
68753       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
68754       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
68755       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
68756       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
68757       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
68758       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
68759       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
68760       - SUBNET is DELETED when these are DELETED HOST-ROUTE
68761     required:
68762     - subnet-id
68763     - dhcp-enabled
68764     properties:
68765       subnet-id:
68766         type: string
68767         description: Subnet ID, should be UUID.
68768       subnet-name:
68769         type: string
68770         description: Name associated with the subnet.
68771       neutron-subnet-id:
68772         type: string
68773         description: Neutron id of this subnet
68774       gateway-address:
68775         type: string
68776         description: gateway ip address
68777       network-start-address:
68778         type: string
68779         description: network start address
68780       cidr-mask:
68781         type: string
68782         description: cidr mask
68783       ip-version:
68784         type: string
68785         description: ip version
68786       orchestration-status:
68787         type: string
68788         description: Orchestration status of this VNF, mastered by MSO
68789       dhcp-enabled:
68790         type: boolean
68791       dhcp-start:
68792         type: string
68793         description: the start address reserved for use by dhcp
68794       dhcp-end:
68795         type: string
68796         description: the last address reserved for use by dhcp
68797       subnet-role:
68798         type: string
68799         description: role of the subnet, referenced when assigning IPs
68800       ip-assignment-direction:
68801         type: string
68802         description: ip address assignment direction of the subnet
68803       resource-version:
68804         type: string
68805         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68806       subnet-sequence:
68807         type: integer
68808         format: int32
68809         description: sequence of the subnet
68810       host-routes:
68811         type: array
68812         items:
68813           $ref: "#/getDefinitions/host-route"
68814       relationship-list:
68815         type: array
68816         items:
68817           $ref: "#/getDefinitions/relationship"
68818   subnets:
68819     properties:
68820       subnet:
68821         type: array
68822         items:
68823           $ref: "#/getDefinitions/subnet"
68824   tagged-inventory-item-list:
68825     properties:
68826       inventory-item:
68827         type: array
68828         items:
68829           $ref: "#/getDefinitions/inventory-item"
68830   tenant:
68831     description: |
68832       Openstack tenant
68833       ###### Related Nodes
68834       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
68835       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
68836       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
68837       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
68838       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
68839       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
68840       - TENANT cannot be deleted if linked to VSERVER
68841     required:
68842     - tenant-id
68843     - tenant-name
68844     properties:
68845       tenant-id:
68846         type: string
68847         description: Unique id relative to the cloud-region.
68848       tenant-name:
68849         type: string
68850         description: Readable name of tenant
68851       tenant-context:
68852         type: string
68853         description: This field will store the tenant context.
68854       resource-version:
68855         type: string
68856         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
68857       vservers:
68858         type: array
68859         items:
68860           $ref: "#/getDefinitions/vserver"
68861       relationship-list:
68862         type: array
68863         items:
68864           $ref: "#/getDefinitions/relationship"
68865   tenants:
68866     description: |
68867       Collection of openstack tenants.
68868     properties:
68869       tenant:
68870         type: array
68871         items:
68872           $ref: "#/getDefinitions/tenant"
68873   tunnel-xconnect:
68874     description: |
68875       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
68876       ###### Related Nodes
68877       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
68878     required:
68879     - id
68880     properties:
68881       id:
68882         type: string
68883         description: Allotted Resource id UUID assigned to this instance.
68884       bandwidth-up-wan1:
68885         type: string
68886         description: The WAN uplink bandwidth for WAN1
68887       bandwidth-down-wan1:
68888         type: string
68889         description: The WAN downlink bandwidth for WAN1
68890       bandwidth-up-wan2:
68891         type: string
68892         description: The WAN uplink bandwidth for WAN2
68893       bandwidth-down-wan2:
68894         type: string
68895         description: The WAN downlink bandwidth for WAN2
68896       resource-version:
68897         type: string
68898         description: Concurrency value
68899       relationship-list:
68900         type: array
68901         items:
68902           $ref: "#/getDefinitions/relationship"
68903   tunnel-xconnects:
68904     description: |
68905       This object is used to store the specific tunnel cross connect aspects of an allotted resource
68906     properties:
68907       tunnel-xconnect:
68908         type: array
68909         items:
68910           $ref: "#/getDefinitions/tunnel-xconnect"
68911   update:
68912     description: |
68913       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
68914     required:
68915     - update-node-type
68916     properties:
68917       update-node-type:
68918         type: string
68919       update-node-key:
68920         type: array
68921         items:
68922           $ref: "#/getDefinitions/update-node-key"
68923       update-node-uri:
68924         type: string
68925       action:
68926         type: array
68927         items:
68928           $ref: "#/getDefinitions/action"
68929   update-node-key:
68930     properties:
68931       key-name:
68932         type: string
68933       key-value:
68934         type: string
68935   vce:
68936     description: |
68937       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
68938       ###### Related Nodes
68939       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
68940       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
68941       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
68942       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
68943       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
68944       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
68945       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
68946       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
68947     required:
68948     - vnf-id
68949     - vnf-name
68950     - vnf-type
68951     properties:
68952       vnf-id:
68953         type: string
68954         description: Unique id of VNF.  This is unique across the graph.
68955       vnf-name:
68956         type: string
68957         description: Name of VNF.
68958       vnf-name2:
68959         type: string
68960         description: Alternate name of VNF.
68961       vnf-type:
68962         type: string
68963         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.
68964       service-id:
68965         type: string
68966         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
68967       regional-resource-zone:
68968         type: string
68969         description: Regional way of organizing pservers, source of truth should define values
68970       prov-status:
68971         type: string
68972         description: Trigger for operational monitoring of this resource by Service Assurance systems.
68973       operational-status:
68974         type: string
68975         description: Indicator for whether the resource is considered operational
68976       license-key:
68977         type: string
68978         description: OBSOLETE -  do not use
68979       equipment-role:
68980         type: string
68981         description: Network role being played by this VNF
68982       orchestration-status:
68983         type: string
68984         description: Orchestration status of this VNF, mastered by MSO
68985       heat-stack-id:
68986         type: string
68987         description: Heat stack id corresponding to this instance, managed by MSO
68988       mso-catalog-key:
68989         type: string
68990         description: Corresponds to the SDN-C catalog id used to configure this VCE
68991       vpe-id:
68992         type: string
68993         description: Unique ID of VPE connected to this VCE.
68994       v6-vce-wan-address:
68995         type: string
68996         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
68997       ipv4-oam-address:
68998         type: string
68999         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
69000       resource-version:
69001         type: string
69002         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69003       ipv4-loopback0-address:
69004         type: string
69005         description: Loopback0 address
69006       entitlement-resource-uuid:
69007         type: string
69008         description: OBSOLETE -  see child relationships
69009       port-groups:
69010         type: array
69011         items:
69012           $ref: "#/getDefinitions/port-group"
69013       licenses:
69014         type: array
69015         items:
69016           $ref: "#/getDefinitions/license"
69017       entitlements:
69018         type: array
69019         items:
69020           $ref: "#/getDefinitions/entitlement"
69021       relationship-list:
69022         type: array
69023         items:
69024           $ref: "#/getDefinitions/relationship"
69025   vces:
69026     description: |
69027       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
69028     properties:
69029       vce:
69030         type: array
69031         items:
69032           $ref: "#/getDefinitions/vce"
69033   vf-module:
69034     description: |
69035       a deployment unit of VNFCs
69036       ###### Related Nodes
69037       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
69038       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
69039       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
69040       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
69041       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
69042       - TO model-ver( vf-module org.onap.relationships.inventory.IsA model-ver, Many2One)
69043       - VF-MODULE cannot be deleted if linked to VNFC
69044     required:
69045     - vf-module-id
69046     - is-base-vf-module
69047     properties:
69048       vf-module-id:
69049         type: string
69050         description: Unique ID of vf-module.
69051       vf-module-name:
69052         type: string
69053         description: Name of vf-module
69054       heat-stack-id:
69055         type: string
69056         description: Heat stack id corresponding to this instance.
69057       orchestration-status:
69058         type: string
69059         description: orchestration status of this vf-module, mastered by MSO
69060       is-base-vf-module:
69061         type: boolean
69062       resource-version:
69063         type: string
69064         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69065       model-invariant-id:
69066         type: string
69067         description: the ASDC model id for this resource or service model.
69068       model-version-id:
69069         type: string
69070         description: the ASDC model version for this resource or service model.
69071       persona-model-version:
69072         type: string
69073         description: the ASDC model version for this resource or service model.
69074       model-customization-id:
69075         type: string
69076         description: captures the id of all the configuration used to customize the resource for the service.
69077       widget-model-id:
69078         type: string
69079         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
69080       widget-model-version:
69081         type: string
69082         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
69083       contrail-service-instance-fqdn:
69084         type: string
69085         description: the Contrail unique ID for a service-instance
69086       module-index:
69087         type: integer
69088         format: int32
69089         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
69090       selflink:
69091         type: string
69092         description: Path to the controller object.
69093       relationship-list:
69094         type: array
69095         items:
69096           $ref: "#/getDefinitions/relationship"
69097   vf-modules:
69098     description: |
69099       Collection of vf-modules, a deployment unit of VNFCs
69100     properties:
69101       vf-module:
69102         type: array
69103         items:
69104           $ref: "#/getDefinitions/vf-module"
69105   vig-server:
69106     description: |
69107       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
69108       ###### Related Nodes
69109       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
69110     required:
69111     - vig-address-type
69112     properties:
69113       vig-address-type:
69114         type: string
69115         description: indicates whether the VIG is for AVPN or INTERNET
69116       ipaddress-v4-vig:
69117         type: string
69118         description: v4 IP of the vig server
69119       ipaddress-v6-vig:
69120         type: string
69121         description: v6 IP of the vig server
69122       resource-version:
69123         type: string
69124         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69125       relationship-list:
69126         type: array
69127         items:
69128           $ref: "#/getDefinitions/relationship"
69129   vig-servers:
69130     properties:
69131       vig-server:
69132         type: array
69133         items:
69134           $ref: "#/getDefinitions/vig-server"
69135   vip-ipv4-address-list:
69136     description: |
69137       IPv4 Address Range
69138       ###### Related Nodes
69139       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69140       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
69141       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
69142       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
69143     required:
69144     - vip-ipv4-address
69145     properties:
69146       vip-ipv4-address:
69147         type: string
69148         description: IP address
69149       vip-ipv4-prefix-length:
69150         type: integer
69151         format: int64
69152         description: Prefix length, 32 for single address
69153       vlan-id-inner:
69154         type: integer
69155         format: int64
69156         description: Inner VLAN tag
69157       vlan-id-outer:
69158         type: integer
69159         format: int64
69160         description: Outer VLAN tag
69161       is-floating:
69162         type: boolean
69163         description: Indicator of fixed or floating address
69164       resource-version:
69165         type: string
69166         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69167       neutron-network-id:
69168         type: string
69169         description: Neutron network id of the interface that address belongs to
69170       neutron-subnet-id:
69171         type: string
69172         description: Neutron id of subnet that address belongs to
69173       relationship-list:
69174         type: array
69175         items:
69176           $ref: "#/getDefinitions/relationship"
69177   vip-ipv6-address-list:
69178     description: |
69179       IPv6 Address Range
69180       ###### Related Nodes
69181       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69182       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
69183       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
69184       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
69185     required:
69186     - vip-ipv6-address
69187     properties:
69188       vip-ipv6-address:
69189         type: string
69190         description: IP address
69191       vip-ipv6-prefix-length:
69192         type: integer
69193         format: int64
69194         description: Prefix length, 128 for single address
69195       vlan-id-inner:
69196         type: integer
69197         format: int64
69198         description: Inner VLAN tag
69199       vlan-id-outer:
69200         type: integer
69201         format: int64
69202         description: Outer VLAN tag
69203       is-floating:
69204         type: boolean
69205         description: Indicator of fixed or floating address
69206       resource-version:
69207         type: string
69208         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69209       neutron-network-id:
69210         type: string
69211         description: Neutron network id of the interface that address belongs to
69212       neutron-subnet-id:
69213         type: string
69214         description: Neutron id of subnet that address belongs to
69215       relationship-list:
69216         type: array
69217         items:
69218           $ref: "#/getDefinitions/relationship"
69219   virtual-data-center:
69220     description: |
69221       Virtual organization of cloud infrastructure elements in a data center context
69222       ###### Related Nodes
69223       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
69224       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
69225       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
69226     required:
69227     - vdc-id
69228     - vdc-name
69229     properties:
69230       vdc-id:
69231         type: string
69232         description: Unique ID of the vdc
69233       vdc-name:
69234         type: string
69235         description: Name of the virtual data center
69236       resource-version:
69237         type: string
69238         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69239       relationship-list:
69240         type: array
69241         items:
69242           $ref: "#/getDefinitions/relationship"
69243   virtual-data-centers:
69244     description: |
69245       Virtual organization of cloud infrastructure elements in a data center context
69246     properties:
69247       virtual-data-center:
69248         type: array
69249         items:
69250           $ref: "#/getDefinitions/virtual-data-center"
69251   vlan:
69252     description: |
69253       Definition of vlan
69254       ###### Related Nodes
69255       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
69256       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
69257       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
69258       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
69259       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
69260       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
69261       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
69262       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
69263       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
69264     required:
69265     - vlan-interface
69266     - in-maint
69267     - is-ip-unnumbered
69268     properties:
69269       vlan-interface:
69270         type: string
69271         description: String that identifies the interface
69272       vlan-id-inner:
69273         type: integer
69274         format: int64
69275         description: Inner VLAN tag
69276       vlan-id-outer:
69277         type: integer
69278         format: int64
69279         description: Outer VLAN tag
69280       resource-version:
69281         type: string
69282         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69283       speed-value:
69284         type: string
69285         description: Captures the numeric part of the speed
69286       speed-units:
69287         type: string
69288         description: Captures the units corresponding to the speed
69289       vlan-description:
69290         type: string
69291         description: Used to describe (the service associated with) the vlan
69292       backdoor-connection:
69293         type: string
69294         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
69295       vpn-key:
69296         type: string
69297         description: This indicates the customers VPN ID associated with this vlan
69298       orchestration-status:
69299         type: string
69300         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
69301       in-maint:
69302         type: boolean
69303       prov-status:
69304         type: string
69305         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
69306       is-ip-unnumbered:
69307         type: boolean
69308       relationship-list:
69309         type: array
69310         items:
69311           $ref: "#/getDefinitions/relationship"
69312       l3-interface-ipv4-address-list:
69313         type: array
69314         items:
69315           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
69316       l3-interface-ipv6-address-list:
69317         type: array
69318         items:
69319           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
69320   vlans:
69321     properties:
69322       vlan:
69323         type: array
69324         items:
69325           $ref: "#/getDefinitions/vlan"
69326   vnf:
69327     description: |
69328       Abstract vnf class
69329     required:
69330     - vnf-id
69331     properties:
69332       vnf-id:
69333         type: string
69334         description: Unique id of VNF.  This is unique across the graph.
69335   vnf-image:
69336     description: |
69337       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
69338       ###### Related Nodes
69339       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
69340       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
69341     required:
69342     - vnf-image-uuid
69343     - application
69344     - application-vendor
69345     properties:
69346       vnf-image-uuid:
69347         type: string
69348         description: Unique ID of this asset
69349       application:
69350         type: string
69351         description: The application that the image instantiates.
69352       application-vendor:
69353         type: string
69354         description: The vendor of the application.
69355       application-version:
69356         type: string
69357         description: The version of the application.
69358       selflink:
69359         type: string
69360         description: URL to endpoint where AAI can get more details
69361       resource-version:
69362         type: string
69363         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69364       relationship-list:
69365         type: array
69366         items:
69367           $ref: "#/getDefinitions/relationship"
69368   vnf-images:
69369     description: |
69370       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
69371     properties:
69372       vnf-image:
69373         type: array
69374         items:
69375           $ref: "#/getDefinitions/vnf-image"
69376   vnfc:
69377     description: |
69378       ###### Related Nodes
69379       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
69380       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
69381       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
69382       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
69383       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
69384       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
69385       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
69386       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
69387       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
69388     required:
69389     - vnfc-name
69390     - nfc-naming-code
69391     - nfc-function
69392     - in-maint
69393     - is-closed-loop-disabled
69394     properties:
69395       vnfc-name:
69396         type: string
69397         description: Unique ID of vnfc.
69398       nfc-naming-code:
69399         type: string
69400         description: Short code that is used in naming instances of the item being modeled
69401       nfc-function:
69402         type: string
69403         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
69404       prov-status:
69405         type: string
69406         description: prov status of this vnfc
69407       orchestration-status:
69408         type: string
69409         description: Orchestration status of this VNF, mastered by APP-C
69410       ipaddress-v4-oam-vip:
69411         type: string
69412         description: Oam V4 vip address of this vnfc
69413       in-maint:
69414         type: boolean
69415       is-closed-loop-disabled:
69416         type: boolean
69417       group-notation:
69418         type: string
69419         description: Group notation of VNFC
69420       model-invariant-id:
69421         type: string
69422         description: the ASDC model id for this resource or service model.
69423       model-version-id:
69424         type: string
69425         description: the ASDC model version for this resource or service model.
69426       resource-version:
69427         type: string
69428         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69429       relationship-list:
69430         type: array
69431         items:
69432           $ref: "#/getDefinitions/relationship"
69433       l3-interface-ipv4-address-list:
69434         type: array
69435         items:
69436           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
69437       l3-interface-ipv6-address-list:
69438         type: array
69439         items:
69440           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
69441   vnfcs:
69442     description: |
69443       virtual network components associated with a vserver from application controller.
69444     properties:
69445       vnfc:
69446         type: array
69447         items:
69448           $ref: "#/getDefinitions/vnfc"
69449   volume:
69450     description: |
69451       Ephemeral Block storage volume.
69452       ###### Related Nodes
69453       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
69454     required:
69455     - volume-id
69456     - volume-selflink
69457     properties:
69458       volume-id:
69459         type: string
69460         description: Unique ID of block storage volume relative to the vserver.
69461       volume-selflink:
69462         type: string
69463         description: URL to endpoint where AAI can get more details
69464       resource-version:
69465         type: string
69466         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69467       relationship-list:
69468         type: array
69469         items:
69470           $ref: "#/getDefinitions/relationship"
69471   volume-group:
69472     description: |
69473       Persistent block-level storage.
69474       ###### Related Nodes
69475       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
69476       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
69477       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
69478       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
69479       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
69480     required:
69481     - volume-group-id
69482     - volume-group-name
69483     - vnf-type
69484     properties:
69485       volume-group-id:
69486         type: string
69487         description: Unique ID of volume-group.
69488       volume-group-name:
69489         type: string
69490         description: Name of the volume group.
69491       heat-stack-id:
69492         type: string
69493         description: Heat stack id corresponding to this volume-group
69494       vnf-type:
69495         type: string
69496         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.
69497       orchestration-status:
69498         type: string
69499         description: Orchestration status of this volume-group
69500       model-customization-id:
69501         type: string
69502         description: captures the id of all the configuration used to customize the resource for the service.
69503       vf-module-model-customization-id:
69504         type: string
69505         description: helps relate the volume group to the vf-module whose components will require the volume group
69506       resource-version:
69507         type: string
69508         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69509       relationship-list:
69510         type: array
69511         items:
69512           $ref: "#/getDefinitions/relationship"
69513   volume-groups:
69514     description: |
69515       Collection of persistent block-level storage.
69516     properties:
69517       volume-group:
69518         type: array
69519         items:
69520           $ref: "#/getDefinitions/volume-group"
69521   volumes:
69522     description: |
69523       Collection of ephemeral Block storage volumes.
69524     properties:
69525       volume:
69526         type: array
69527         items:
69528           $ref: "#/getDefinitions/volume"
69529   vpls-pe:
69530     description: |
69531       VPLS Provider Edge routers.
69532       ###### Related Nodes
69533       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
69534       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
69535       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
69536       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
69537       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
69538     required:
69539     - equipment-name
69540     properties:
69541       equipment-name:
69542         type: string
69543       prov-status:
69544         type: string
69545         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
69546       ipv4-oam-address:
69547         type: string
69548         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).
69549       equipment-role:
69550         type: string
69551         description: Client should send valid enumerated value, e.g., VPLS-PE.
69552       vlan-id-outer:
69553         type: integer
69554         format: int64
69555         description: Temporary location for stag to get to VCE
69556       resource-version:
69557         type: string
69558         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69559       relationship-list:
69560         type: array
69561         items:
69562           $ref: "#/getDefinitions/relationship"
69563       p-interfaces:
69564         type: array
69565         items:
69566           $ref: "#/getDefinitions/p-interface"
69567       lag-interfaces:
69568         type: array
69569         items:
69570           $ref: "#/getDefinitions/lag-interface"
69571   vpls-pes:
69572     description: |
69573       Collection of VPLS Provider Edge routers
69574     properties:
69575       vpls-pe:
69576         type: array
69577         items:
69578           $ref: "#/getDefinitions/vpls-pe"
69579   vpn-binding:
69580     description: |
69581       VPN binding
69582       ###### Related Nodes
69583       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
69584       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
69585       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
69586       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
69587       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
69588       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
69589     required:
69590     - vpn-id
69591     - vpn-name
69592     properties:
69593       vpn-id:
69594         type: string
69595         description: VPN ID, globally unique within A&AI
69596       vpn-name:
69597         type: string
69598         description: VPN Name
69599       vpn-platform:
69600         type: string
69601         description: the platform associated with the VPN example AVPN, Mobility
69602       vpn-type:
69603         type: string
69604         description: Type of the vpn, should be taken from enumerated/valid values
69605       vpn-region:
69606         type: string
69607         description: region of customer vpn
69608       customer-vpn-id:
69609         type: string
69610         description: id for this customer vpn
69611       route-distinguisher:
69612         type: string
69613         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
69614       resource-version:
69615         type: string
69616         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69617       route-targets:
69618         type: array
69619         items:
69620           $ref: "#/getDefinitions/route-target"
69621       relationship-list:
69622         type: array
69623         items:
69624           $ref: "#/getDefinitions/relationship"
69625         description: l3-networks relate to vpn-bindings
69626   vpn-bindings:
69627     properties:
69628       vpn-binding:
69629         type: array
69630         items:
69631           $ref: "#/getDefinitions/vpn-binding"
69632   vserver:
69633     description: |
69634       Virtual Servers, aka virtual machine or VM.
69635       ###### Related Nodes
69636       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
69637       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
69638       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
69639       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
69640       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
69641       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
69642       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
69643       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
69644       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
69645       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
69646       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
69647       - VSERVER is DELETED when these are DELETED L-INTERFACE
69648       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
69649     required:
69650     - vserver-id
69651     - vserver-name
69652     - vserver-selflink
69653     - in-maint
69654     - is-closed-loop-disabled
69655     properties:
69656       vserver-id:
69657         type: string
69658         description: Unique identifier for this vserver relative to its tenant
69659       vserver-name:
69660         type: string
69661         description: Name of vserver
69662       vserver-name2:
69663         type: string
69664         description: Alternative name of vserver
69665       prov-status:
69666         type: string
69667         description: Trigger for operational monitoring of this resource by Service Assurance systems.
69668       vserver-selflink:
69669         type: string
69670         description: URL to endpoint where AAI can get more details
69671       in-maint:
69672         type: boolean
69673       is-closed-loop-disabled:
69674         type: boolean
69675       resource-version:
69676         type: string
69677         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
69678       volumes:
69679         type: array
69680         items:
69681           $ref: "#/getDefinitions/volume"
69682       relationship-list:
69683         type: array
69684         items:
69685           $ref: "#/getDefinitions/relationship"
69686       l-interfaces:
69687         type: array
69688         items:
69689           $ref: "#/getDefinitions/l-interface"
69690   vservers:
69691     description: |
69692       Collection of virtual Servers, aka virtual machines or VMs.
69693     properties:
69694       vserver:
69695         type: array
69696         items:
69697           $ref: "#/getDefinitions/vserver"
69698   zone:
69699     description: |
69700       A zone is a grouping of assets in a location homing to the same connections into the CBB
69701       ###### Related Nodes
69702       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
69703       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
69704       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
69705       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
69706       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
69707     required:
69708     - zone-id
69709     - zone-name
69710     - design-type
69711     - zone-context
69712     properties:
69713       zone-id:
69714         type: string
69715         description: Code assigned by AIC to the zone
69716       zone-name:
69717         type: string
69718         description: English name associated with the zone
69719       design-type:
69720         type: string
69721         description: Design of zone [Medium/Large…]
69722       zone-context:
69723         type: string
69724         description: Context of zone [production/test]
69725       status:
69726         type: string
69727         description: Status of a zone.
69728       resource-version:
69729         type: string
69730         description: Concurrency value
69731       relationship-list:
69732         type: array
69733         items:
69734           $ref: "#/getDefinitions/relationship"
69735   zones:
69736     description: |
69737       Collection of zones
69738     properties:
69739       zone:
69740         type: array
69741         items:
69742           $ref: "#/getDefinitions/zone"